搜索特定广播组

从广播组列表中搜索特定广播组。

请求 URL

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

请求参数

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

取值范围：

  • name：广播组名称
  • number：广播组号码
order_by 否 String 定义显示顺序。

取值范围：

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

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
total_number Integer 匹配此搜索条件的广播组总数。
data Array<Paging_Basicinfo> 广播组的基本信息。
Paging_Basicinfo
参数 类型 说明
id Integer 广播组的唯一 ID。
number String 广播组号码。
name String 广播组名称。
type String 广播组类型。
  • 1_way_paging：单向传呼
  • 1_way_multicast_paging：单向组播
  • 2_way_intercom：双向对讲
member_list Array<Member_List> 单向传呼或双向对讲的成员。
broadcast Array<Broadcast> 广播者。
Member_List
参数 类型 说明
type String 成员类型。
  • extension：分机
  • ext_group：分机组
name String 分机或分机组的名称。
number String 分机号码。
id Integer 分机或分机组的唯一 ID。
Broadcast
参数 类型 说明
type String 成员类型。
  • extension：分机
  • ext_group：分机组
name String 分机或分机组的名称。
number String 分机号码。
id Integer 分机或分机组的唯一 ID。

示例

请求示例

从列表中搜索广播组 6600。

GET /openapi/v1.0/paging/search?page=1&page_size=3&search_value=6600&access_token=mNFzdIZWSAeeNfU2s3NIzTmtUdCDQOM8 HTTP/1.1
Host: 192.168.5.150:8088

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 1,
    "data": [
        {
            "id": 1,
            "number": "6600",
            "name": "6600",
            "type": "1_way_paging",
            "member_list": [
                {
                    "type": "extension",
                    "name": "Leo Ball",
                    "number": "1001",
                    "id": "83"
                },
                {
                    "type": "extension",
                    "name": "Phillip Huff",
                    "number": "1002",
                    "id": "84"
                },
                {
                    "type": "extension",
                    "name": "Terrell Smith",
                    "number": "1003",
                    "id": "82"
                }
            ],
            "broadcast": [
                {
                    "type": "extension",
                    "name": "Troy Daniel",
                    "number": "1000",
                    "id": "80"
                }
            ]
        }
    ]
}