Resize a Cloud PBX
Resize the capacity of a specific Cloud PBX.
Request URL
PUT {base_url}/dm/open_api/v1/cloud_pbx/instances/{cloudPbxId}/capacity
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
BodyParameter | Required | Type | Description |
---|---|---|---|
Authorization | Yes | String | Pass the access token in the header. Format: Bearer {access_token}. |
Parameter | Required | Type | Description |
---|---|---|---|
extensionCapacity | Yes | Long | The number of extensions for the Cloud PBX. |
concurrentCallCapacity | Yes | Long | The number of concurrent calls for the Cloud PBX. |
recordingStatus | Yes | String | Whether to enable call recording feature for the Cloud
PBX. Valid value:
|
recordingCapacity | Yes | Long | The number of the call recording minutes. |
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
Resize the recording capacity of a Cloud PBX (ID: 42100) to 600 minutes.PUT /dm/open_api/v1/cloud_pbx/instances/42100/capacity HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NjY0NSwidmVyc2lvbiI6MTY2Mzc0MTEyNSwicmVmcmVzaFZlcnNpb24iOjE2NjQ1MTY5MjJ9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjY0NTE4NzIyLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiI1NmZhYTE0Ni0wZjUyLTRhYjEtYjkyNy1jNDZiMjRkNjc1MTYiLCJjbGllbnRfaWQiOiJ5QXN4ZzdITkRFczNxSHprQk1aUU5Pblo2NTBPRUNNWSJ9.jOfSRWoL0lXUd3_xRsVpvymkqu7FuLyrAGIIoNbsh_U
Content-Type: application/json
{
"extensionCapacity":30,
"concurrentCallCapacity":15,
"recordingStatus":"Enabled",
"recordingCapacity":600
}
Response exampleHTTP/1.1 200 OK
{
"requestId": "8b4491aab168766a3c44bc3683bc75c2",
"status": "Success",
"time": 1664517231
}