查询单台 IP 话机的信息

查询单台 IP 话机的自动配置信息。

请求 URL

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

请求参数

1.
参数 是否必填 类型 说明
id Integer IP 话机的唯一 ID。
注: 可使用 搜索特定 IP 话机 接口查询话机 ID。

响应参数

2.
参数 类型 说明
errcode Integer 返回错误码。
  • 0:请求成功。
  • 非零值:请求失败。
注: 更多错误码和错误信息说明,请参见 错误码 & 错误信息
errmsg String 返回信息。
  • SUCCESS:请求成功。
  • FAILURE:请求失败。
data Array<Phone_Details> IP 话机详情。
Phone_Details
3.
参数 类型 说明
mac String IP 话机的 MAC 地址。
vendor String 话机供应商。
model String 话机型号。
template_name String 应用到 IP 话机的配置模板的名称。
provisioning_method String IP 话机的配置方式。

provisioning_link String IP 话机的配置链接。
enb_rps_auth Integer
是否启用 “第一次自动配置时要求验证” 选项。
  • 0:禁用。首次触发自动配置无需验证。
  • 1:启用。首次触发自动配置需要验证。
assigned_extension String 分配给 IP 话机的分机的唯一 ID。
id Integer IP 话机的唯一 ID。

示例

请求示例

查询 IP 话机 (ID 为 4) 的自动配置信息。

GET /openapi/v1.0/phone/get?access_token=wyzVFisp8XmFhiJTlpRmt2LxAuzELh5X&id=4 HTTP/1.1

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

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "data": {
        "mac": "11:55:44:66:33:22",
        "vendor": "Yealink",
        "model": "SIP-CP960",
        "template_name": "YSDP_YealinkCP",
        "provisioning_method": "rps",
        "provisioning_link": "https://yeastardocs.example.yeastarcloud.com:443/api/autoprovision/6gEzigLFhMGntjd8",
        "enb_rps_auth": 1,
        "assigned_extension": "6",
        "id": 4
    }
}