Pause an Agent

Pause an agent's service in a queue. After an agent is paused, the agent would not receive calls from the queue.

Request URL

{base_url}/{api_path}/queue/pause_agent?token={token}

Request parameters

Parameter Required Type Description
queuenumber Yes Integer Queue number.
extnumber Yes Integer Dynamic agent's number.

Response parameters

Parameter Type Description
status String Request result.
  • Success
  • Failed

Examples

Request example

Pause the service of agent 1000 in queue 6700.

POST /api/v2.0.0/queue/pause_agent?token=1e3b3ebb6a974cb42ed31de5413df52d HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150

{
	"queuenumber": "6700",
	"extnumber": "1000"
}
Response example
HTTP/1.1 200 OK
Server: Boa/0.94.14rc21
Accept-Ranges: bytes
Connection: close
Content-Type: application/json
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE

{
    "status": "Success"
}