Set Agent State for a Particular Channel

file:important.png Pre-Release Notice: The information contained on this page is not considered final and is managed under the terms and conditions found in the Pre-release Agreement. This page provides the most up-to-date reference information available for this pre-release version and is restricted for use by those who have signed the Pre-release Agreement with Genesys to acquire an early version of the software.

Updates Agent States for a Channel

Method	POST
URL	By channel: /me/channels/{channelId}
Name	Type	Mandatory	Description
Parameters
operationName	string	Y	For example: NotReady, Ready, OutToLunch

Output

Ready Channel

Puts a User's channel ('chat', 'email', and so on) into a 'Ready' state, meaning that the User is open to receiving interaction invitations for that multimedia channel.

Input Parameters

POST on /me/channels/{channelId}

{
"operationName":"Ready"
}

Output

Success

{
"status":"ok"
}

Failure

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

NotReady Channel

Puts a User's multimedia channel ('chat', 'email', and so on) into a 'NotReady' state, meaning that the User will not even view an interaction invitation for that multimedia channel.

Input Parameters

POST on /me/channels/{channelId}

{
"operationName":"NotReady"
}

Output

Success

{
"status":"ok"
}

Failure

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