Queue Management – Pause or Unpause Agents

Pause or unpause service (i.e. receiving queue calls) for agents in the specified queue.

Request URL

GET {base_url}/{api_path}/queue/agent_pause?access_token={access_token}

Request parameters

Parameter Required Type Description
ext_ids Yes String The extension ID(s) of the agent(s).
Note:
queue_id Yes Integer The unique ID of the queue.
Note: You can query the queue's ID using Search Specific Queues.
operation Yes String Pause or unpause service (i.e. receiving queue calls) for agents in the queue.
Valid value:
  • pause: Pause receiving queue calls.
  • unpause: Unpause receiving queue calls.
reason No String Feature code for the pause reason.
Valid value: The feature code for the existing pause reasons on PBX.
Note:
  • If the PBX plan subscription is NOT Enterprise Plan or Ultimate Plan, do NOT pass this parameter, otherwise the request will fail.
  • You can query the feature code for the existing pause reasons using Query Queue Pause Reason List.

Response parameters

Parameter Type Description
errcode Integer Returned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsg String Returned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.

Examples

Request example

Pause service for two agents (Extension ID: 73 & 85) in a queue (ID: 2) with the pause reason "Lunch" (Feature code: *01).

GET /openapi/v1.0/queue/agent_pause?access_token=qxvj1AOWpDrl5ScEPNavCJ9Eu6KQL4yS&ext_ids=73,85&queue_id=2&operation=pause&reason=*01 HTTP/1.1
Host: 192.168.5.150:8088
Response example
HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS"
}