Channels

A channel is a means of communication between agents and users. Each agent can have an availability for one or more channels. Channel resources are part of the Agent Availabilities JSON response format.

JSON format

Channels are represented as JSON objects with the following properties:

Name	Type	Read-only	Mandatory	Description
attributes	object	false	true	Channel Attributes.
id	string	false	true	The channel's JSON:API ID.
relationships	object	false	false	A relationships object containing the key work_items, whose values provide refer to included work item resources.
type	string	false	true	The JSON:API type channels.

Example

{
  "attributes": {
    "max_capacity": 1,
    "name": "messaging",
    "status": "online",
    "updated_at": "2022-06-21T10:23:25.583732Z",
    "work_item_count": 5
  },
  "id": "agent_availabilities|10011|channels|messaging",
  "relationships": {
    "work_items": {
      "data": [
        {
          "id": "agent_availabilities|10011|channels|messaging|work_items|201",
          "type": "work_items"
        },
        {
          "id": "agent_availabilities|10011|channels|messaging|work_items|202",
          "type": "work_items"
        },
        {
          "id": "agent_availabilities|10011|channels|messaging|work_items|203",
          "type": "work_items"
        }
      ],
      "links": {
        "next": "https://example.zendesk.com/api/v2/agent_availabilities/10011/channels/messaging/relationships/work_items?page%5Bafter%5D=203"
      },
      "meta": {
        "has_more": true
      }
    }
  },
  "type": "channels"
}