查询单个分机密码

查询单个分机的注册密码和语音信箱密码。

请求 URL

GET {base_url}/{api_path}/extension/getpassword?access_token={access_token}

请求参数

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

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0:请求成功。
  • 非零值:请求失败。
注: 更多错误码和错误信息说明,请参见 错误码 & 错误信息
errmsg String 返回信息。
  • SUCCESS:请求成功。
  • FAILURE:请求失败。
password String 注册密码或语音信箱密码。
注: 你可以使用 Base 64 解码工具还原密码的原始内容。

示例

请求示例

查询分机 1000 (ID: 80) 的注册密码。

GET /openapi/v1.0/extension/getpassword?access_token=fJ71SE6TCRLAGUyv2J4YQco3jeqE1H47&id=80&type=reg_password HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "password": "SGM2bUFyVzYyTQ=="
}