删除云 PBX

删除一台或多台云 PBX。

请求 URL

DELETE {base_url}/dm/open_api/v1/cloud_pbx/instances

请求参数

请求头
参数 是否必填 类型 说明
Authorization 是 String 在请求头中传递访问 Token。

格式：Bearer {access_token}。
请求体
参数 是否必填 类型 说明
cloudPbxIds 是 Array <Long> 云 PBX ID 列表。
注：
  • 可使用 查询所有云 PBX 接口查询云 PBX ID。
  • 使用半角逗号 , 分隔多个 ID。

响应参数

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

示例

请求示例

删除云 PBX A (ID：43144) 和云 PBX B (ID：43145)。
DELETE /dm/open_api/v1/cloud_pbx/instances HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NjY0NSwidmVyc2lvbiI6MTY2Mzc0MTEyNSwicmVmcmVzaFZlcnNpb24iOjE2NjQ1MjE0NTl9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjY0NTIzMjU5LCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiIwYjA1YjEwNy0xOGQ5LTRlYWEtYTFhMS02YTRhZDAzZTgzMjciLCJjbGllbnRfaWQiOiJ5QXN4ZzdITkRFczNxSHprQk1aUU5Pblo2NTBPRUNNWSJ9.mTwHgU5A3g1sOIA-KHJ39IYAZyC0Wf_OltBJENvzxgM
Content-Type: application/json
{
  cloudPbxIds: [43144, 43145]
}
响应示例
HTTP/1.1 200 OK
{
  "requestId": "e8ee6bb5fb76714c20f8a7bcf6d1bbe7",
  "status": "Success",
  "time": 1664521706
}