搜索特定队列

在队列列表中搜索特定的队列。

请求 URL

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

请求参数


参数	是否必填	类型	说明
page	否	Integer	定义显示第几个页面。
page_size	否	Integer	定义每页显示几项查询结果。
sort_by	否	String	定义排序字段。取值范围： `id`：队列 ID `number`：队列号码 `name`：队列名称 `ring_strategy`：响铃策略
order_by	否	String	定义显示顺序。取值范围： `asc`：升序 `desc`：降序
search_value	否	String	搜索关键字。

响应参数


参数	类型	说明
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`：线性响铃。
client_unique_ringtone	String	当坐席接收到此队列的来电时，其 Linkus 客户端将播放的特色铃声。空字符串：系统将播放在 Linkus 客户端上设置的自定义铃声。其他值：自定义铃声的文件名。
dynamic_agent_list	Array <Dynamic_Agent_List>	动态坐席成员的信息。
static_agent_list	Array <Static_Agent_List>	静态坐席成员的信息。
manager_list	Array <Manager_List>	队列管理员的信息。
enable_time_condition	Integer	是否启用时间条件。 `0`：禁用 `1`：启用
enb_play_holiday_prompt_global	Integer	假期时是否播放提示音。 `0`：禁用 `1`：启用
holiday_dest	String	假期目的地。 `end_call`：挂断。 `extension`：分机。 `ext_vm`：分机语音信箱。 `group_vm`：群语音信箱。 `ivr`：IVR。 `call_flow`：通话流程 `ring_group`：响铃组。 `queue`：队列。 `external_num`：外部号码。 `play_greeting`：播放提示音后退出。
holiday_dest_prefix	String	指定目的地类型 (`holiday_dest`) 不同，此参数返回的值也不同。当目的地类型为 `external_num` 时，此参数返回外部号码的拨号前缀。当目的地类型为 `play_greeting` 时，此参数返回提示音的播放次数。
holiday_dest_value	String	按键的目的地类型 (`holiday_dest`) 不同，返回的参数值也不同。当目的地类型为 `play_greeting` 时，此参数返回自定义提示音的文件名。例如：`demo.wav`。当目的地类型为 `extension`、`ext_vm`、`group_vm`、`ivr`、`call_flow`、`ring_group`、或 `queue` 时，此参数返回目的地的 ID。例如：目的地为分机 2002，则该参数返回分机 2002 的 ID `2`。当目的地的类型为 `external_num` 时，此参数返回外部号码。
ignore_holiday_dest	Integer	是否忽略假期目的地。
outoffice_dest	String	非办公时间目的地。 `end_call`：挂断。 `extension`：分机。 `ext_vm`：分机语音信箱。 `group_vm`：群语音信箱。 `ivr`：IVR。 `call_flow`：通话流程 `ring_group`：响铃组。 `queue`：队列。 `external_num`：外部号码。 `play_greeting`：播放提示音后退出。
outoffice_dest_prefix	String	指定目的地类型 (`outoffice_dest`) 不同，此参数返回的值也不同。当目的地类型为 `external_num` 时，此参数返回外部号码的拨号前缀。当目的地类型为 `play_greeting` 时，此参数返回提示音的播放次数。
outoffice_dest_value	String	按键的目的地类型 (`outoffice_dest_prefix`) 不同，返回的参数值也不同。当目的地类型为 `play_greeting` 时，此参数返回自定义提示音的文件名。例如：`demo.wav`。当目的地类型为 `extension`、`ext_vm`、`group_vm`、`ivr`、`call_flow`、`ring_group`、或 `queue` 时，此参数返回目的地的 ID。例如：目的地为分机 2002，则该参数返回分机 2002 的 ID `2`。当目的地的类型为 `external_num` 时，此参数返回外部号码。
timezone_id	Integer	时区的 ID。

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`：分机。

示例

请求示例

搜索号码为 “6402” 的队列。

GET /openapi/v1.0/queue/search?access_token=6lqF0qYlAOjWxa64DalBZwJ7mynMRKeD&search_value=6402 HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 1,
    "queue_list": [
        {
            "id": 3,
            "number": "6402",
            "name": "技术支持",
            "ring_strategy": "ring_all",
            "client_unique_ringtone": "example.wav",
            "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"
                }
            ]
        }
    ]
}