Query Queue Status

Query user agents' status in a specific queue.

Endpoint

POST /api/v1.1.0/queuestatus/query?token={token}

Request Parameters

Parameter Name Importance Type Description
queueid Required Int Queue number.

Response Parameters

Name Type Description
queues Object Queue.
queuenumber Int Queue number.
queuestatus Object Queue status.
callercount Int The number of callers who are waiting for answering.
members Object Queue members.
agent Int The agent's number.
agentstatus Int 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

Examples

Request Example
Request to query user agents' status in queue 6700.
POST /api/v1.1.0/queuestatus/query?token=1e3b3ebb6a974cb42ed31de5413df52d HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: api.yeastarcloud.com
{
    "queueid": "6700"
}
Response Example
HTTP/1.1 200 OK
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE
{
    "status": "Success",
    "queues": [
        {
            "queuenumber": "6700",
            "queuestatus": [
                {
                    "callercount": "0",
                    "members": [
                        {
                            "agent": "8034",
                            "agentstatus": "1"
                        },
                        {
                            "agent": "8033",
                            "agentstatus": "1"
                        },
                        {
                            "agent": "5007",
                            "agentstatus": "1"
                        },
                        {
                            "agent": "1004",
                            "agentstatus": "9"
                        },
                        {
                            "agent": "6000",
                            "agentstatus": "5"
                        },
                        {
                            "agent": "6036",
                            "agentstatus": "5"
                        },
                        {
                            "agent": "6001",
                            "agentstatus": "5"
                        }
                    ]
                }
            ]
        }
    ]
}