Channel Attributes

The attributes of a channel associated with an agent (part of the Channels resource).

JSON format

Channel Attributes are represented as JSON objects with the following properties:

Name	Type	Read-only	Mandatory	Description
max_capacity	integer	false	false	The maximum number of work items the agent can have for the channel. Returned only if Omnichannel Contact Center is enabled.
name	string	false	true	The name of the channel.
status	string	false	false	The agent's status for the channel. Possible values are: online, away, transfers_only, offline, invisible, and disconnected. online means the agent is available and can be assigned work items for the channel. away means the agent is temporarily unavailable and is not assigned new work items. transfers_only means the agent is not assigned new work items from the queue, but another agent can still transfer work items to them. offline means the agent is unavailable and is not assigned work items. invisible means the agent is signed in but appears offline and is not assigned work items. This value is equivalent to offline and is only used for the Chat channel. disconnected means the agent lost their connection to the Agent Workspace (for example, the browser was closed) or signed out. This value is only used for the Messaging and Chat channels on accounts that use omnichannel routing.
updated_at	string	false	false	A timestamp indicating when the agent's status last changed for the channel.
work_item_count	integer	false	true	The number of work items assigned to the agent for the channel.

Channel Attributes.

Example

{
  "max_capacity": 1,
  "name": "messaging",
  "status": "online",
  "updated_at": "2022-06-21T10:23:25.583732Z",
  "work_item_count": 5
}