查询队列列表

查询 PBX 的队列列表。

请求 URL

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

请求参数

参数 是否必填 类型 说明
page 否 Integer 定义显示第几个页面。
page_size 否 Integer 定义每页显示几项查询结果。
sort_by 否 String 定义排序字段。

取值范围：

  • id：队列 ID
  • number：队列号码
  • name：队列名称
  • ring_strategy：响铃策略
order_by 否 String 定义显示顺序。

取值范围：

  • asc：升序
  • desc：降序

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
total_number Integer 队列总数。
queue_list Array <Queue_List> 每个队列的信息。
Queue_List
参数 类型 说明
id Integer 队列的唯一 ID。
number String 队列号码。
name String 队列的名称。
ring_strategy String 队列的响铃策略。
  • ring_all：同时响铃。
  • least_recent：最久未被叫响铃。
  • fewest_calls：最少接通响铃。
  • random：随机响铃。
  • rrmemory：循环响铃。
  • linear：线性响铃。
dynamic_agent_list Array <Dynamic_Agent_List> 动态坐席成员的信息。
static_agent_list Array <Static_Agent_List> 静态坐席成员的信息。
manager_list Array <Manager_List> 队列管理员的信息。
Dynamic_Agent_List
参数 类型 说明
text String 动态坐席成员的姓名。
text2 String 动态坐席成员的分机号码。
value String 动态坐席成员的分机 ID。
type String 动态坐席成员的类型。
  • extension：分机。
Static_Agent_List
参数 类型 说明
text String 静态坐席成员的姓名。
text2 String 静态坐席成员的分机号码。
value String 静态坐席成员的分机 ID。
type String 静态坐席成员的类型。
  • extension：分机。
Manager_List
参数 类型 说明
text String 队列管理员的姓名。
text2 String 队列管理员的分机号码。
value String 队列管理员的分机 ID。
type String 队列管理员的类型。
  • extension：分机。

示例

请求示例

以 “响铃策略” 作为排序字段，获取队列列表。

GET /openapi/v1.0/queue/list?access_token=pemM88QipJrY9ya1rwob8qO0s4U9vVo1&sort_by=ring_strategy HTTP/1.1
Host: 192.168.5.150:8088
响应示例
HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 3,
    "queue_list": [
        {
            "id": 2,
            "number": "6401",
            "name": "市场",
            "ring_strategy": "random",
            "dynamic_agent_list": null,
            "static_agent_list": [
                {
                    "text": "Wayne Wang",
                    "text2": "1010",
                    "value": "76",
                    "type": "extension"
                },
                {
                    "text": "Shawn Shaw",
                    "text2": "1011",
                    "value": "83",
                    "type": "extension"
                }
            ],
            "manager_list": [
                {
                    "text": "Wayne Wang",
                    "text2": "1010",
                    "value": "76",
                    "type": "extension"
                },
                {
                    "text": "Phillip Huff",
                    "text2": "1001",
                    "value": "85",
                    "type": "extension"
                }
            ]
        },
        {
            "id": 1,
            "number": "6400",
            "name": "销售",
            "ring_strategy": "ring_all",
            "dynamic_agent_list": null,
            "static_agent_list": [
                {
                    "text": "Leo Ball",
                    "text2": "1000",
                    "value": "73",
                    "type": "extension"
                }
            ],
            "manager_list": [
                {
                    "text": "Leo Ball",
                    "text2": "1000",
                    "value": "73",
                    "type": "extension"
                }
            ]
        },
        {
            "id": 3,
            "number": "6402",
            "name": "技术支持",
            "ring_strategy": "ring_all",
            "dynamic_agent_list": [
                {
                    "text": "Leo Ball",
                    "text2": "1000",
                    "value": "73",
                    "type": "extension"
                },
                {
                    "text": "Phillip Huff",
                    "text2": "1001",
                    "value": "85",
                    "type": "extension"
                }
            ],
            "static_agent_list": [
                {
                    "text": "Madison Cooper",
                    "text2": "1004",
                    "value": "96",
                    "type": "extension"
                },
                {
                    "text": "Kevin Connor",
                    "text2": "1005",
                    "value": "97",
                    "type": "extension"
                },
                {
                    "text": "Kristin Hale",
                    "text2": "1006",
                    "value": "92",
                    "type": "extension"
                }
            ],
            "manager_list": [
                {
                    "text": "Leo Ball",
                    "text2": "1000",
                    "value": "73",
                    "type": "extension"
                }
            ]
        }
    ]
}