Agent Management – Log in to or Log out of Queues
Log in or log out the specified dynamic agent from one or more queues.
Request URL
GET {base_url}/{api_path}/agent/login?access_token={access_token}
Request parameters
Parameter | Required | Type | Description |
---|---|---|---|
ext_id | Yes | Integer | The extension ID of the dynamic agent. Note: You can query agent's extension
ID using Search Specific Extensions.
|
queue_ids | No | String | Important: If this
parameter is not included, the system will log the agent
in or out of all queues.
Note:
|
operation | Yes | String | Log in to or log out the dynamic agent from the specified
queue(s). Valid value:
|
is_paused | No | Integer | Whether to pause service for the dynamic agent after logging
him or her to the queue. Valid value:
Note: If you don't configure this
parameter, it will be filled with the default value
0 . |
reason | No | String | Feature code for the pause reason. Valid value: The feature code for the existing pause
reasons on PBX. Note:
|
Response parameters
Parameter | Type | Description |
---|---|---|
errcode | Integer | Returned error code.
Note: You can check the error code and
error message in Error Code and Error Message.
|
errmsg | String | Returned message.
|
Examples
Request example
Log in the dynamic agent (Extension ID: 85) to all his or her assigned queues, and pause service for the agent after login.
GET /openapi/v1.0/agent/login?access_token=u6UfsayUeBpUrwwpaBs6hkDeCzEE6D6t&ext_id=85&operation=login&is_paused=1 HTTP/1.1
Host: yeastardocs.example.yeastarcloud.com
Response exampleHTTP/1.1 200 OK
{
"errcode": 0,
"errmsg": "SUCCESS"
}