Query Information of a Message Queue

Query the detailed information of a specific message queue.

Request URL

GET {base_url}/{api_path}/message_queue/get?access_token={access_token}

Request parameters

Parameter Required Type Description
id Yes Integer The unique ID of the message queue.
Note: You can query the message queue ID using Search Specific Message Queues.

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.
data Object<Msg_Queue> The detailed information of the message queue.
Msg_Queue
Parameter Type Description
id Integer The unique ID of the message queue.
name String The name of the message queue.
members Array<Members> The information of the agents in the message queue.
assignment_mode String The assignment mode of chat sessions sent to the message queue.
  • none: Agents cannot pick up sessions.
  • auto: The first agent to respond will automatically pick up the session.
  • manual: Agents can take over the session by clicking the Pick Up button.
Members
Parameter Type Description
id Integer The ID of the agent.
extension_id Integer The ID of the agent's extension.
ext_num String The number of the agent's extension.
caller_id_name String The name of the agent.

Examples

Request example

GET /openapi/v1.0/message_queue/get?id=3&access_token=N0BNItIvHFIHYruFE0EHoyqWsl8TflrJ HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "data": {
        "id": 3,
        "name": "PreSales Consult Queue",
        "members": [
            {
                "id": 7,
                "extension_id": 39,
                "ext_num": "59996",
                "caller_id_name": "James Smith"
            },
            {
                "id": 8,
                "extension_id": 23,
                "ext_num": "59998",
                "caller_id_name": "Robert Williams"
            },
            {
                "id": 9,
                "extension_id": 10,
                "ext_num": "59999",
                "caller_id_name": "Michael Brown"
            }
        ],
        "assignment_mode": "manual"
    }
}