Stop a Cloud PBX
Stop a specific Cloud PBX.
Request URL
PUT {base_url}/dm/open_api/v1/cloud_pbx/instances/{cloudPbxId}/stop
Request parameters
Path parameterParameter | Required | Type | Description |
---|---|---|---|
cloudPbxId | Yes | Long | The ID of the Cloud PBX. Note: You can query
the Cloud PBX ID using Query All the Cloud PBXs. |
Headers
Parameter | Required | Type | Description |
---|---|---|---|
Authorization | Yes | String | Pass the access token in the header. Format: Bearer {access_token}. |
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:
|
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
Stop a Cloud 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
Response
exampleHTTP/1.1 200 OK
{
"requestId": "876294ddb3b29cfaa056df2c05139db8",
"status": "Success",
"time": 1664519543
}