停止云 PBX

停止指定的云 PBX。

请求 URL

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

请求参数

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

格式：Bearer {access_token}。

响应参数

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

示例

请求示例

停止指定云 PBX (ID：42100)。
PUT /dm/open_api/v1/cloud_pbx/instances/42100/stop HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NjY0NSwidmVyc2lvbiI6MTY2Mzc0MTEyNSwicmVmcmVzaFZlcnNpb24iOjE2NjQ1MTk1MjF9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjY0NTIxMzIxLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiJmM2NjOGUxMy1mMzMxLTQ0YWQtYTg5ZC0zZWFmYWRlZDllNWIiLCJjbGllbnRfaWQiOiJ5QXN4ZzdITkRFczNxSHprQk1aUU5Pblo2NTBPRUNNWSJ9.cFSD30vGl1PAj6fniber5LzjUqsWD3y9Lhf4bZdMxyA
响应示例
HTTP/1.1 200 OK
{
  "requestId": "876294ddb3b29cfaa056df2c05139db8",
  "status": "Success",
  "time": 1664519543
}