搜索特定分机组

在分机组列表中搜索特定分机组。

请求 URL

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

请求参数

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

取值范围：

  • id
  • name
order_by 否 String 定义显示顺序。

取值范围：

  • asc：升序
  • desc：降序
search_value 否 String 搜索关键字。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
total_number Integer 搜索到的分机组总数。
data Array<ExtGroup_info> 分机组信息。
ExtGroup_info
参数 类型 说明
id Integer 分机组的唯一 ID。
name String 分机组名称。
member_select String 分机组成员的添加方式。
  • sel_all_ext：添加所有分机。
  • sel_specific：仅添加指定分机。
total_extensions Integer 该分机组中的成员分机总数。

示例

请求示例

从分机组列表中搜索分机组 “Default_All_Extensions”。

GET /openapi/v1.0/extensiongroup/search?access_token=Hb19mIhO9E1lfCWCF01P9D4R7MiG1Jow&search_value=Default_All_Extensions HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 1,
    "data": [
        {
            "id": 1,
            "name": "Default_All_Extensions",
            "member_select": "sel_all_ext",
            "total_extensions": 36
        }
    ]
}