API Interface Summary List
This topic provides a summary list of the YCM API interfaces.
Note: You MUST include a User-Agent header with every
request that you submit to the YCM API, so that the Yeastar Central Management can
identify your application and respond to the request. For example,
User-Agent: OpenAPI
.API authentication
Function | HTTP method | API endpoint |
---|---|---|
Request access token | POST | /dm/open_api/oauth/token |
Refresh access token | POST | /dm/open_api/oauth/token |
Revoke refresh token | DELETE | /dm/open_api/oauth/token/refresh_token |
Subscription
Function | HTTP method | API endpoint |
---|---|---|
Query the Subscription of P-Series Hosting Package | GET | /dm/open_api/v1/subscription |
Query the P-Series Cloud Edition Feature Plan Statistics | GET | /dm/open_api/v1/subscription/plan_statistics |
Query the Remote Management Connections | GET | /dm/open_api/v1/subscription/rm_connections |
Cloud PBX
Function | HTTP method | API endpoint |
---|---|---|
Query all the Cloud PBXs | GET | /dm/open_api/v2/cloud_pbx/instances |
Query a Specific Cloud PBX | GET | /dm/open_api/v1/cloud_pbx/instances/{cloudPbxId} |
Query the Status of a Cloud PBX | GET | /dm/open_api/v1/cloud_pbx/instances/{cloudPbxId}/status |
Query the Activation Information of a Cloud PBX | GET | /dm/open_api/v1/cloud_pbx/instances/{cloudPbxId}/activation_info |
Query the Customer(s) of a Cloud PBX | GET | /dm/open_api/v1/cloud_pbx/instances/{cloudPbxId}/customers |
Query Available Regions | GET | /dm/open_api/v1/cluster/regions |
Query Available Domain Names | GET | /dm/open_api/v1/cluster/domains |
Create a Cloud PBX | POST | /dm/open_api/v1/cloud_pbx/instances |
Send PBX Activation Emails | POST | /dm/open_api/v1/cloud_pbx/instances/{cloudPbxId}/activation_email |
Start a Cloud PBX | PUT | /dm/open_api/v1/cloud_pbx/instances/{cloudPbxId}/start |
Update the Information of a Cloud PBX | PUT | /dm/open_api/v1/cloud_pbx/instances/{cloudPbxId} |
Update the Customer(s) of a Cloud PBX | PUT | /dm/open_api/v1/cloud_pbx/instances/{cloudPbxId}/customers |
Resize a Cloud PBX | PUT | /dm/open_api/v1/cloud_pbx/instances/{cloudPbxId}/capacity |
Stop a Cloud PBX | PUT | /dm/open_api/v1/cloud_pbx/instances/{cloudPbxId}/stop |
Delete Cloud PBXs | DELETE | /dm/open_api/v1/cloud_pbx/instances |
Customer
Function | HTTP method | API endpoint |
---|---|---|
Query all the Customers | GET | /dm/open_api/v1/customers |
Query a Specific Customer | GET | /dm/open_api/v1/customers/{customerId} |
Create a Customer | POST | /dm/open_api/v1/customers |
Update a Customer | PUT | /dm/open_api/v1/customers/{customerId} |
Delete Customers | DELETE | /dm/open_api/v1/customers |
YCM User
Function | HTTP method | API endpoint |
---|---|---|
Query all the YCM users | GET | /dm/open_api/v2/users |
Query a Specific YCM User | GET | /dm/open_api/v1/users/{userId} |
Query the Subscription of a YCM User | GET | /dm/open_api/v1/users/{userId}/subscription_info |
Create a YCM User | POST | /dm/open_api/v1/users |
Send an Account Activation Email | POST | /dm/open_api/v1/users/{userId}/activation_email |
Update the Information of a YCM User | PUT | /dm/open_api/v1/users/{userId} |
Update the Subscription of a YCM User | PUT | /dm/open_api/v1/users/{userId}/subscription_info |
Delete YCM Users | DELETE | /dm/open_api/v1/users |
Firmware
Function | HTTP method | API endpoint |
---|---|---|
Query Available Firmwares | GET | /dm/open_api/v1/firmware |
Backup Files
Function | HTTP method | API endpoint |
---|---|---|
Query all the Backup Files | GET | /dm/open_api/v1/backup_file |
Restore a Backup | POST | /dm/open_api/v1/backup_file/restore |
Query the Restore Status | GET | /dm/open_api/v1/backup_file/restore_result/{restoreDstPbxSn} |
Provisioning Template
Function | HTTP method | API endpoint |
---|---|---|
Query All the Provisioning Templates | GET | /dm/open_api/v1/provision_template |