Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

The agentNotReady function

Updated on October 6, 2021

This function is used to set the agent state to Not Ready. When the state is Not Ready, then the agent does not receive calls from the queue. However, the agent must be logged in to at least one queue before this function is invoked.

If there is an error in the request, handle it as explained in Handling errors.

This function uses the following parameters:

Parameters of the agentNotReady function

agentIDThe agent ID on the Automatic Call Distributor (ACD). This is a required parameter and it is populated during the login request.
workModeThe work mode status of the desired agent.
reasonCodeThe reason code (string) value that is used when the agent logs out of the queue.
linkDefinitionThe CTI link definition that is configured. You can save this parameter in a property that is available throughout a session.
optionsThe parameter that holds optional properties that are implementation specific.
successThe call back function that is invoked on success.
failureThe call back function that is invoked on failure.

To send the agent not ready request to the CTI server, copy the function from the interface file and implement it.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us