搜索特定响铃组

在响铃组列表中搜索特定的响铃组。

请求 URL

GET {base_url}/{api_path}/ringgroup/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 搜索到的响铃组的总数。
data Array <Ring_Group_Info> 每个响铃组的基本信息。
Ring_Group_Info
参数 类型 说明
id Integer 响铃组的唯一 ID。
number String 响铃组号码。
name String 响铃组名称。
ring_strategy String 响铃组的响铃策略。
  • ring_all：响铃组中所有可用的分机同时响铃。
  • sequentially：响铃组中可用的分机按顺序响铃。
  • memory_hunt：先响铃响铃组中的第一个可用分机。如果在响铃期间没有应答，则继续响铃下一个可用分机，直到列表中的所有可用分机都响铃完毕。
  • custom：根据分机各自的延迟响铃时间进行响铃，并在各自的响铃超时时间后结束响铃。
member_count Integer 响铃组中的成员数量。

示例

请求示例

搜索响铃策略为 “ring_all” 的响铃组。

GET /openapi/v1.0/ringgroup/search?access_token=Av4ZxfcjqeHAWvNK9IeISDC6TnmiTpra&search_value=ring_all HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
响应示例
HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 2,
    "data": [
        {
            "id": 8018,
            "number": "8018",
            "name": "Marketing",
            "ring_strategy": "ring_all",
            "member_count": 2
        },
        {
            "id": 8022,
            "number": "8022",
            "name": "Technical Support",
            "ring_strategy": "ring_all",
            "member_count": 10
        }
    ]
}