Query Message Queue List

Query the message queue list.

Request URL

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

Request parameters

Parameter Required Type Description
page Yes Integer Define which page is displayed.
page_size Yes Integer Define how many records per page.

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.
total_number Integer The total number of the message queues.
list Array<Msg_Queue> The information of the message queues.
Msg_Queue
Parameter Type Description
id Integer The unique ID of the message queue.
name String The name of the message queue.

Examples

Request example

GET /openapi/v1.0/message_queue/list?access_token=FdOMCWyxiQLAF9r9JqHg0fTCecqtp6Vo&page=1&page_size=5 HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 11,
    "list": [
        {
            "id": 3,
            "name": "PreSales Consult Queue"
        },
        {
            "id": 4,
            "name": "After Sales Service Queue"
        },
        {
            "id": 5,
            "name": "Technical Support Queue"
        },
        {
            "id": 6,
            "name": "Customer Care Queue"
        },
        {
            "id": 13,
            "name": "Product Feedback Queue"
        }
    ]
}