Query Queue Status

Query agent status in a specified queue.

Request URL


Request parameters

Parameter Required Type Description
number Yes String Queue number.

Response parameters

Parameter Type Description
status String Request result.
  • Success
  • Failed
queues Array <QueueInfo> Queue information.
Parameter Type Description
number String Queue number.
queuestatus Array <QueuestatusInfo> Queue status.
Parameter Type Description
callercount Integer The number of on-hold callers.
members Array <MemberInfo> Information of queue members.
Parameter Type Description
agent Integer Agent number.
agentstatus Integer The agent status.
  • 0-Unknown: Unknown
  • 1-Not In Use: The agent is idle
  • 2-In Use: The agent is in a call
  • 3-Busy: Unknown
  • 5-Unavailable: The agent's extension is unregistered
  • 6-Ringing: The agent's extension is ringing
  • 7-In Use Ringing: The agent receives a new call during a call
  • 8-On Hold: The agent holds a call
  • 9-Paused: The agent is paused, and would not receive calls
  • 10-warp-up time: The agent is in the wrap-up state


Request example

Query agent status in queue 6700.

POST /api/v2.0.0/queue/query_status?token=1e3b3ebb6a974cb42ed31de5413df52d
Content-Type:application/json; charset=utf-8

	"number": "6700"
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",
	"queues": [
			"number": "6700",
			"queuestatus": [
					"callercount": "0",
					"members": [
							"agent": "1000",
							"agentstatus": "1"
							"agent": "4000",
							"agentstatus": "1"