更新云 PBX 的 DID 关联关系

为云 PBX 分配 DID 号码以自动绑定对应的共享中继，或移除云 PBX 现有的 DID 关联。

注： 仅在云 PBX 固件为 84.19.0.22 或更高版本时生效。

请求 URL

PUT {base_url}/dm/open_api/v1/cloud_pbx/instances/{cloudPbxId}/did

请求参数

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

格式：Bearer {access_token}。
请求体
参数 是否必填 类型 说明
trunkDidRelations 是 Array <Trunk_DID_Relation> 要分配给云 PBX 的 DID 号码及其关联的共享中继的对应关系列表。
Trunk_DID_Relation
注： 若要移除 PBX 与所有 DID 号码之间的现有关联，则需要将 trunkDidRelations 参数留空，即不传递下列子级参数。更多信息，请参见 请求示例 2。
参数 是否必填 类型 说明
trunkId 是 Integer 共享中继的 ID。
注： 可使用 查询所有共享中继 查询中继 ID。
didIds 是 Array <Integer> DID 号码的 ID 列表。
注： 可使用 查询所有 DID 号码 查询 DID 号码 ID。

响应参数

参数 类型 说明
requestId String 请求 ID，作为该请求的唯一标识，用于快速定位请求。
status String 请求结果。
  • Success：请求成功。
  • Failed：请求失败。
time Long 请求响应的时间。
注： YCM API 响应返回的是时间戳，如有需要，你可以将时间戳转换成具体的日期和时间。详细操作方法，请参见 将时间戳转换为日期和时间。

示例

请求示例 1

将注册中继 (ID: 6681) 中关联的 DID 号码 (ID: 50036 & 50044) 分配给云 PBX (ID: 4808)。

PUT /dm/open_api/v1/cloud_pbx/instances/4808/did HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer ******
Content-Type: application/json
{
    "trunkDidRelations": [
        {
            "didIds": [
                50036,50044
            ],
            "trunkId": 6681
        }
    ]
}

请求示例 2

清除云 PBX (ID: 4808) 绑定的所有 DID。

PUT /dm/open_api/v1/cloud_pbx/instances/4808/did HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer ******
Content-Type: application/json
{
    "trunkDidRelations": [ ]
}

响应示例

HTTP/1.1 200 OK
{
    "requestId": "d42cdd6453bc1378ac74877a480f22c5",
    "status": "Success",
    "time": 1747100716
}