Use this request to log in, log out or pause a queue agent.
If successful, the Service returns the agent number and the status as a QueueAgent resource.
The request is made by an App that is registered to a User account.
To update the statuses of agents registered to a particular queue in a desired context, issue a HTTP PUT request:
This section describes how to format the request to the service.
The following parameters must be sent in the URI fragment:
If successful, the request returns the agent number and the status as a QueueAgent resource, as well as the following HTTP statuses:
|200||The QueueAgent resource is returned.|
|204||There are no QueueAgent resources to be returned.|
When it fails, the request returns the following error codes:
|400||status_invalid||Value supplied in type parameter is missing or invalid. The parameter must be set to one of the following value: 0 for DialIn, 1 for DialOut and 2 for Hangup.|
|400||extension_invalid||Value supplied in the URI-Fragment as extension is invalid. The parameter must reference the number of an existing Queue extension and cannot be set to @self.|
|400||qag_agent_invalid||Value supplied in status parameter is missing or invalid. The parameter can take the values: 0 for Logged Out, 1 for Online, 2 for Paused.|
Below you can find an example that will help you understand the request and the response.
This example updates the agent 0003*210 which is registered to the queue 0003*212. The request is made by an App on behalf of a User.
Assuming that the request has been successful, the Service sends the following answer:
Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 4.0 International.