Jump to: navigation, search

Channels API

A channel typically represents a particular type of media such as e-mail or chat, but it can also represent specific online platforms such as Salesforce. Channels are linked to Features in a one-to-many relationship: a feature can have multiple channels, while each channel is only associated with one feature.


The following operations are supported on /me/subresources=* :

Operation Name HTTP Operation Description Permissions
Overall User State GET Returns all of an Agent's channel and device states. Agent

The following operations are supported on /me/devices:

Operation Name HTTP Operation Description Permissions
Get All Devices GET Returns all of an Agent's device states. Agent
Get a Particular Device GET Returns all of an Agent's specific device states. Agent

The following operations will be supported on /me/channels:

Operation Name HTTP Operation Description Permissions
Get All Multimedia Channels GET Returns all of an Agent's channel states. Agent
Get a Particular Multimedia Channel GET Returns all of an Agent's specific channel state. Agent
Ready Channel POST Sets an Agent's channel to Ready. Agent
NotReady Channel POST Sets an Agent's channel to NotReady. Agent

The following operations will be supported on /me:

Operation Name HTTP Operation Description Permissions
Ready for all Channels POST Sets all user channels to 'Ready' Agent
NotReady for all Channels POST Sets all user channels to 'NotReady' Agent
DNDOn POST Activates Do Not Disturb. Agent
DNDOff POST Deactivates Do Not Disturb. Agent
This page was last edited on October 31, 2023, at 13:26.
Comments or questions about this documentation? Contact us for support!