Send PBX Activation Emails

Send PBX activation email to the associated customers.

Request URL

POST {base_url}/dm/open_api/v1/cloud_pbx/instances/{cloudPbxId}/activation_email

Request parameters

Path parameter
Parameter 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}.
Body
Parameter Required Type Description
customerIds Yes Array <Long> The ID(s) of the customer(s) that are associated with the Cloud PBX.
Note:

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
accountList Array <String> The email addresses to which the system has successfully sent the activation emails.

Example

Request example

Send PBX activation emails of a Cloud PBX (ID: 42100) to the associated customers.
POST /dm/open_api/v1/cloud_pbx/instances/42100/activation_email
Host: ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NjY0NSwidmVyc2lvbiI6MTY2Mzc0MTEyNSwicmVmcmVzaFZlcnNpb24iOjE2NjQ0NTIxMDJ9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjY0NDUzOTAyLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiI0NDM1ZDZmMy1mMjhmLTRlNmItYTZhYS00MzUyNWIwOTZiOGQiLCJjbGllbnRfaWQiOiJ5QXN4ZzdITkRFczNxSHprQk1aUU5Pblo2NTBPRUNNWSJ9.E9gvDRL2zna5HA5lBv0Vyyv10EtNGgfyp-PmOmA8D88
Content-Type: application/json
{
  "customerIds":[50329421,50086182]
}
Response example
HTTP/1.1 200 OK
{
  "data": {
    "accountList": [
      "leo@example.com",
      "fakemailaddress@example.com"
    ]
  },
  "requestId": "1dcdae9f2865b91de18987b56110608f",
  "status": "Success",
  "time": 1664452327
}