Query the Activation Information of a Cloud PBX

Query the activation information (including activation URL and activation code) of an unactivated Cloud PBX.

Request URL

GET {base_url}/dm/open_api/v1/cloud_pbx/instances/{cloudPbxId}/activation_info

Request parameters

Path parameters
Parameter Required Type Description
cloudPbxId Yes Long The ID of the unactivated Cloud PBX.
Note: You can query the ID and activation status of the Cloud PBX 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
data Object <Details> The detailed information.
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.
Details
Parameter Type Description
cloudPbxId Integer The ID of the Cloud PBX.
activationUrl String The activation URL of the Cloud PBX.
Note: The activation URL is valid in 7 days.
activationCode String The activation code of the Cloud PBX.
Note: The activation code can only be used ONCE.

Example

Request example

Query the activation information of an unactivated Cloud PBX (ID: 116671).

GET /dm/open_api/v1/cloud_pbx/instances/116671/activation_info
Host: ycmtest.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NjY0NSwidmVyc2lvbiI6MTY2Mzc0MTEyNSwicmVmcmVzaFZlcnNpb24iOjE2NjQ0NDE5NjF9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjY0NDQzNzYwLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiIwNzM2ZDJkMS0wMDZjLTQ1ZmUtYTBiZS0zNWNjNjIxNTVmYjIiLCJjbGllbnRfaWQiOiJ5QXN4ZzdITkRFczNxSHprQk1aUU5Pblo2NTBPRUNNWSJ9.h3Hz2suOlciWP9X8bxrAtsOaoCGEFad76kWc3xxk-nQ

Response example

{
  "data": {
    "cloudPbxId": 116671,
    "activationUrl": "https://unactivatedpbx.example.yeastarcloud.com/activation?code=FMY5wFNH7XC4X4t8ZMhD3T5kuNhwLEMPQW0dhH30AfM79MkzNrMsMHgGeZkLqJPW",
    "activationCode": "33gsnr3e"
  },
  "requestId": "7c39319bb125555d99c9ef143efbe936",
  "status": "Success",
  "time": 1700105153
}