Delete Cloud PBXs

Request URL

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

Request parameters

Headers


Parameter	Required	Type	Description
Authorization	Yes	String	Pass the access token in the header. Format: Bearer `{access_token}`.

Body


Parameter	Required	Type	Description
cloudPbxIds	Yes	Array <Long>	The ID list of Cloud PBXs. Note: You can query the Cloud PBX ID using Query All the Cloud PBXs. Use a comma to separate multiple IDs.

Response parameters


Parameter	Type	Description
requestId	String	The unique ID of the request, which can be used to quickly locate the request.
status	String	Request result: `Success` `Failed`
time	Long	The response time. Note: The YCM API response returns a timestamp, you can convert the timestamp to detailed date and time as needed. For more information, see Convert Timestamp to Local Date and Time.

Example

Request example

Delete Cloud PBX A (ID:43144) and Cloud 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]
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "e8ee6bb5fb76714c20f8a7bcf6d1bbe7",
  "status": "Success",
  "time": 1664521706
}