搜索特定 IP 话机

从自动配置话机列表中搜索特定 IP 话机。

请求 URL

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

请求参数

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

取值范围：

  • vendor：话机供应商
  • model：话机型号
order_by 否 String 定义显示顺序。

取值范围：

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

响应参数

表 2.
参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
total_number Integer 搜索到的 IP 话机总数量。
data Array<Phone_Info> 搜索到的 IP 话机信息。
Phone_Info
表 3.
参数 类型 说明
id Integer IP 话机的唯一 ID。
mac String IP 话机的 MAC 地址。
vendor String 话机供应商。
model String 话机型号。
template_name String 应用到 IP 话机的配置模板的名称。
ip String IP 话机的私网 IP 地址。
注： 该参数始终返回空值。
firmware String IP 话机的固件版本。
assigned_ext_status String 分配给 IP 话机的分机的注册状态。
  • Unregistered：未注册。

  • Registered：已注册。
assigned_ext_num String 分配给 IP 话机的分机号码。
注： 如果该参数返回 Unassigned，表示此 IP 话机尚未分配分机。
assigned_ext_name String 分配给 IP 话机的分机用户姓名。
注： 如果该参数返回 Unassigned，表示此 IP 话机尚未分配分机。

示例

请求示例

GET /openapi/v1.0/phone/search?access_token=sSpTRV82rCV5Y8lOzb7yDBcRwvkqGjpe&page=1&page_size=3&sort_by=vendor&order_by=asc HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
User-Agent: OpenAPI

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 36,
    "data": [
        {
            "id": 14,
            "mac": "3c:xx:xx:xx:xx:39",
            "vendor": "Alcatel-Lucent Enterprise",
            "model": "M8",
            "template_name": "YSDP_AleM8",
            "ip": "",
            "firmware": "2.13.01",
            "assigned_ext_status": "Unregistered",
            "assigned_ext_num": "2005",
            "assigned_ext_name": "Kristin Hale"
        },
        {
            "id": 21,
            "mac": "3c:xx:xx:xx:xx:ae",
            "vendor": "Alcatel-Lucent Enterprise",
            "model": "M3",
            "template_name": "YSDP_AleMyriad",
            "ip": "",
            "firmware": "2.13.39",
            "assigned_ext_status": "Unregistered",
            "assigned_ext_num": "2007",
            "assigned_ext_name": "Ashley Gardner"
        },
        {
            "id": 48,
            "mac": "00:xx:xx:xx:xx:54",
            "vendor": "Cisco",
            "model": "Cisco3905",
            "template_name": "YSDP_Cisco3905",
            "ip": "",
            "firmware": "",
            "assigned_ext_status": "Registered",
            "assigned_ext_num": "2003",
            "assigned_ext_name": "Dave Haris"
        },
      ... ...
    ]
}