Get Stream Availability

This API checks the availability status of a stream (channel) and returns its current state.

Availability States

The API returns one of the following states:

• 0 - Channel is not active
• 1 - Available (during business hours with agents ready)
• 2 - Busy (agent overload during business hours)
• 3 - Unavailable (outside business hours or on special days)

Query Parameters

ignoreAutomationExsistance

Controls whether automation (bot) availability is considered in the status check.

• true - Ignores automation presence (returns status based only on human agents)
• false (default) - Includes automation in availability check

Note: Since bots are always available, including automation may mask Busy/Unavailable states.

autoAssign

Filters agents based on their auto-assignment permissions.

• true - Returns Available (state 1) only if agents with auto-assignment enabled are available
• false (default) - Returns status regardless of auto-assignment settings

includeDetails

Controls the response format and level of detail.

• true - Returns detailed response with availability state, agent list, statuses, and permissions
• false (default) - Returns only the availability state number (0, 1, 2, or 3)

Path Parameters

SUBSTREAM_ID

Required when subchannels are configured for the brand. Omit this parameter if subchannels are not in use.

Usage Examples

Without Subchannel (Single Query Parameter)

GET /streams/11345/streamavailability?includeDetails=true

With Subchannel (Multiple Query Parameters)

GET /streams/TbxH9RJIQrWI0hzA%3d%3d/substreams/12/streamavailability?ignoreAutomationExsistance=false&autoAssign=true

Voice Call Specific Behavior

For voice call streams, availability states have specific conditions:

State 1 (Available)

All of the following conditions must be met:

• Agents are active and online
• Agents are not currently on calls
• Agents have auto-assignment permission enabled for this stream/substream

State 2 (Busy)

• All agents with proper stream/substream permissions are currently on active calls

State 3 (Unavailable)

Any one of the following conditions triggers this state:

• Current time is outside business hours
• Special day is configured (holiday, maintenance, etc.)
• All agents are in AWAY status or inactive
• No active voice agents have the required auto-assignment permissions for this stream/substream