Jump to: navigation, search

Set Agent States Across all Channels

Use the following requests to set Agent States across all channels.

Ready for All Channels

Sets all of an agent's channel statuses to "Ready", meaning that the agent is ready to receive interaction invitations for all the agent's media channels.

Input Parameters

POST on /me

{
"operationName":"Ready"
} 

Output

Success

{
"status":"ok"
} 

Failure

{
"status":"error",
"errorDescription":details
} 

NotReady For All Channels

Sets all of an agent's channel statuses to "NotReady", meaning that the agent is not ready to receive interaction invitations for any of the agent's media channels.

Input Parameters

POST on /me

{
"operationName":"NotReady"
} 

Output

Success

{
"status":"ok"
} 

Failure

{
"status":"error",
"errorDescription":details
} 

DndOn

Activates the "Do Not Disturb" status. This applies to all devices and channels, and overrides statuses such as "Ready."

Input Parameters

POST on /me

{
"operationName":"DoNotDisturbOn"
} 

Output

Success

{
"status":"ok"
} 

See Cometd Notifications.

Failure

{
"status":"error",
"errorDescription":details
} 

DndOff

Deactivates the "Do Not Disturb" status. This applies to all devices and channels, and overrides statuses such as "Ready."

Input Parameters

POST on /me

{
"operationName":"DoNotDisturbOff"
}  

Output

Success

 {
"status":"ok"
}  

See Cometd Notifications.

Failure

{
"status":"error",
"errorDescription":details
}  
This page was last edited on October 31, 2023, at 13:31.
Comments or questions about this documentation? Contact us for support!