Get Stream Availability

This API checks the availability of the stream (channel) and returns the channel’s state.

Enum:
Channel is not active = 0
Available (during business hours) = 1
Busy (Overload on agents during business hours) = 2
Unavailable (Off business hours or during a special day) = 3

Query Parameters include the following Boolean options:
A. Ignoring Automation
Since the bot is always available, the busy and unavailable states will not reflect if the automation function is included.

• When ignoreAutomationExsistance=true: API Ignores automation
• When ignoreAutomationExsistance=false (default): API Includes automation in the checking

B. Auto Assignment
• When autoAssign=true: API returns Available (Response 1) only for agents who have the Auto Assignment toggle turned ON in the channel permissions.
• When autoAssign=false (default): API returns status independently of auto-assignment.

C. Response Format
• When includeDetails=true: The API returns a detailed response object containing the availability state, along with a list of all agents and their current statuses and permissions for the specified stream or sub-stream
• When includeDetails=false (default): Returns only the availability state (1,2,3)


Comments:
When subchannels are used in the brand, the SUBSTREAM_ID becomes a REQUIRED path parameter.

Example of no subchannel and one query param:
https://api.bumpyard.com/streams/11345/streamavailability?includeDetails=true

Example of two query params:
https://api.bumpyardpro.com/streams/TbxH9RJIQrWI0hzA%3d%3d/substreams/12/streamavailability/ignoreAutomationExsistance=false&autoAssign=true

For Voice Calls, response states reflect the following conditions:

• Response 1 (Available) - Agents are active, not on calls, AND have auto-assignment permission to the stream/sub stream. (Auto Assignment toggle must be turned ON for the agent in the Channel permissions)


• Response 2 (Busy) – All agents with proper permissions for the stream/sub stream, are currently on other calls.


• Response 3 (Unavailable) - Any of these conditions are true:
- Not during business hours
- Special Day (holiday, etc.)
- All agents are in AWAY status / Not active
- No active voice agents have the required auto-assignment permissions to the stream/sub stream