调用云 PBX 的 POST 接口

通过 YCM 二次开发接口 (API) 调用 P 系列云 PBX 的 HTTP POST API 接口。本文以编辑指定云 PBX 上某部门为例进行说明。

使用要求

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

请求 URL

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

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

在本文示例中，将 ** 通配符替换为 openapi/{version}/organization/update，其中 {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。
name 否 String 部门名称。
parent_id 否 Integer 父部门的唯一 ID。
注： 可使用云 PBX API 的搜索特定部门接口查询部门 ID。

响应参数

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

本文示例返回请求 ID 和编辑部门的响应参数，如下表所示。

参数 类型 说明
requestId String 请求 ID，作为该请求的唯一标识，用于快速定位请求。
errcode Integer 云 PBX API 接口返回的错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多云 PBX API 的错误码和错误信息，请参见 错误码 & 错误信息。
errmsg String 云 PBX API 接口返回的错误信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。

示例

请求示例

编辑指定云 PBX 上的部门 (ID：2) 的名称。

POST /dm/open_api/v1/cloud_pbx/3658B43XXXXXM4ZK/openapi/v1.0/organization/update HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NjY0NSwidmVyc2lvbiI6MTY2Mzc0MTEyNSwicmVmcmVzaFZlcnNpb24iOjE2NjQ0NTAxOTh9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjY0NDUxOTk4LCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiJmNzAzYjk0Ni1kMzk4LTQxZWEtOTgwZi1hOGZmNWYxODhiNDAiLCJjbGllbnRfaWQiOiJ5QXN4ZzdITkRFczNxSHprQk1aUU5Pblo2NTBPRUNNWSJ9.N9R6s5ttSah3LRdDBowQYdYw8URWhzyJYiD5cdVm2ZM
Content-Type: application/json
{
    "id": 2,
    "name":"Technical Support"
}
响应示例
HTTP/1.1 200 OK
{
    "errcode": 0,
    "requestId": "218ffc1e5e4564c0c3b09e576cf91f64",
    "errmsg": "SUCCESS"
}