调用云 PBX 的 GET 接口

通过 YCM 二次开发接口 (API) 调用 P 系列云 PBX 的 HTTP GET API 接口。本文以查询指定云 PBX 上某个分机的密码为例进行说明。

使用要求

平台 要求
Yeastar 统一管理平台
P 系列云 PBX

请求 URL

GET {base_url}/dm/open_api/v1/cloud_pbx/{sn}/**
注：

请求 URL 中的 ** 作为 路径通配符，表示要调用的云 PBX API 的接口。

在本文示例中，将 ** 通配符替换为 openapi/{version}/extension/getpassword，其中 {version} 表示云 PBX API 的版本。

更多云 PBX API 接口，请参见 P 系列云 PBX 开发者手册。

请求参数

路径参数
参数 是否必填 类型 说明
sn 是 String 云 PBX 的序列号。
注： 可使用 查询所有云 PBX 接口查询云 PBX 的序列号。
请求头
参数 是否必填 类型 说明
Authorization 是 String 在请求头中传递访问 Token。

格式：Bearer {access_token}。
查询参数

查询参数包含目标云 PBX API 接口的请求参数。

在本文示例中，填写查询分机密码的请求参数，如下表所示。

参数 是否必填 类型 说明
id 是 Integer 分机的唯一 ID。
注： 可使用云 PBX API 的搜索特定分机接口查询分机 ID。
type 是 String 密码类型。
取值范围：
  • reg_password：分机注册密码。
  • vm_pin：语音信箱密码。

响应参数

响应参数由 YCM API 调用的请求 ID 和目标云 PBX API 接口返回的数据组成。

本文示例返回请求 ID 和查询分机密码的响应参数，如下表所示。

参数 类型 说明
requestId String 请求 ID，作为该请求的唯一标识，用于快速定位请求。
errcode Integer 云 PBX API 接口返回的错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多云 PBX API 的错误码和错误信息，请参见 错误码 & 错误信息。
errmsg String 云 PBX API 接口返回的错误信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
password String 指定分机的注册密码或语音信箱密码。
注： 你可以使用 Base 64 解码工具还原密码的原始内容。

示例

请求示例

查询指定云 PBX 上的分机 (ID：43) 的注册密码。

GET /dm/open_api/v1/cloud_pbx/3658B43XXXXXM4ZK/openapi/v1.0/extension/getpassword?id=43&type=reg_password HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NjY0NSwidmVyc2lvbiI6MTY2Mzc0MTEyNSwicmVmcmVzaFZlcnNpb24iOjE2NjQ0NTAxOTh9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjY0NDUxOTk4LCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiJmNzAzYjk0Ni1kMzk4LTQxZWEtOTgwZi1hOGZmNWYxODhiNDAiLCJjbGllbnRfaWQiOiJ5QXN4ZzdITkRFczNxSHprQk1aUU5Pblo2NTBPRUNNWSJ9.N9R6s5ttSah3LRdDBowQYdYw8URWhzyJYiD5cdVm2ZM
响应示例
HTTP/1.1 200 OK
{
    "errcode": 0,
    "password": "NVVVYzVPRTU4aw==",
    "requestId": "563b171e03953491f196c1478df3d539",
    "errmsg": "SUCCESS"
}