Update the Subscription of a YCM User

Update the P-Series hosting package subscription of a specific YCM user.

Request URL

PUT {base_url}/open_api/v1/users/{userId}/subscription_info

Request parameters

Path parameter
Parameter Required Type Description
userId Yes Long The ID of the YCM user.
Note: You can query the user ID using Query All the YCM Users.
Headers
Parameter Required Type Description
Authorization Yes String Pass the access token in the header.

Format: Bearer {access_token}.
Body
Parameter Required Type Description
totalExtensions Yes Integer The total number of extensions.
totalConcurrentCalls Yes Integer The total number of concurrent calls.
totalRecordings Yes Integer The total number of call recording minutes.
Note: NOT allowed to reduce the call recording minutes.
minimumExtPerPbx Yes Integer The minimum number of extensions for each PBX.
highAvailability No String Whether to enable the High Availability service or not.
Valid value:
  • subscribed: Enable
  • unsubscribed: Disable

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

Update the P-Series hosting package subscription of a YCM user (ID: 13123).
PUT /dm/open_api/v1/users/13123/subscription_info HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NzM0OSwidmVyc2lvbiI6MTYzODk1OTkwOSwicmVmcmVzaFZlcnNpb24iOjE2NjQ0MzQ0NzN9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjY0NDM2MjczLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiJkZjBkMjY0Zi01NTExLTRjZmYtODAxNC1kNDk1NzI5MWU1YjIiLCJjbGllbnRfaWQiOiJrcDl5eW50bXVlc3VrNWpvV3ZNa1RiQ0J4cU82TEtSaCJ9.vyjCNtFkaEgGIUROdJFHPRiiMefKkXNg5pEBHtnWz8E
Content-Type: application/json
{
  "totalExtensions": 60,
  "totalConcurrentCalls": 8,
  "totalRecordings": 60,
  "minimumExtPerPbx": 11
}
Response example
HTTP/1.1 200 OK
{
  "requestId": "2ffe14a1e92bc4ae222353c60758cc2e",
  "status": "Success",
  "time": 1664434539
}