Quick Start

Click on the console of the navigation bar and select the SMS Service below Notification Services.

Create Message Template

  • In the console, click + New Template.
  • Enter the content of the template, where the variable should be surrounded by ${} . Variable will be populated by value when the API is called. Click Submit.

  • The status for the newly created template is under review. eBaoCloud platform staff will help to verify that your template complies with the laws and regulations as well as SMS service provider's requirements. The review is expected to be completed within 1-2 working days. To ensure that your template passes the review successfully, please pay attention to the template content restrictions.

[!TIP|label: Template Content Restriction Description]

  • Variable names can only be filled in with English letters or combination of English letters and numbers, the first cannot be number, the other variable name cannot be the following string: email, mobile, id, nick, site.
  • When sending sms, the variable content cannot be empty, and can not contain any symbols, the content length should be less than 16 characters.
  • [] is not allowed to be added to the start of the SMS template or the end of the template.
  • If there is a URL in the template, it must be an ICP-filing URL (for China user).
  • Content cannot include marketing, loans, jackpot, lottery, party and government and religious promotion and other information.
  • Not support the financial, financial management, real estate and other content notification SMS and promotional SMS.
  • SMS content cannot contain politically sensitive words and vulgar sensitive words.
  • The template cannot just contain ${}, please specify the structure of the message content.
  • SMS templates do not support special symbols.

Create Message Signature

  • After creating a template, the user can then create a signature which is used in the SMS. Click the tab Sign, then click + New Sign.
  • In the pop-up page, please fill in the signature name. The signature will be sent to the recipient as the beginning of the text message.

    For example: [eBaoCloud] Dear customer, your policy with tail number XXXX has been issued.

  • The status for the newly created signature is under review. eBaoCloud platform staff will help to verify that your signature complies with the laws and regulations as well as SMS service provider's requirements. The review is expected to be completed within 1-2 working days. To ensure that your signature passes the review successfully, please pay attention to the signature content restrictions.

[!TIP|label: Signature Content Restriction Description]

  • Signature length should be between 2 and 8 characters.
  • Can not be pure numbers, pure English, digital English combination.
  • [], (), [] and other symbols should not be included in the signature.

Send Message

After the SMS template code and signature name being configured, the API consumer can call the SMS API to send short messages.

Path: https://[Host]/eBao/1.0/sms/send

The format of the message for sending SMS is as follows:

{
  'phones': [
    '+86xxxxxxxxxxx'
  ],
  'templateCode': 'SMS-xxxxxxxx',
  'signName': 'XXXXX',
  'params': {
    'accountName': 'eBaoCloud'
    'password': '12345678'
  }
}

Return example: The status is 0, indicating successful sending, otherwise, the sending fails.

{
  "status": 0,
  "info": null
}

[!WARNING|label: Restriction Description] We will monitor the SMS template and signature created by users to prevent the content of SMS from violating the requirements of national laws and regulations.

If the message content violates the rules, the relevant users will be frozen. After the account is frozen, the user can not continue to use the SMS service.

Delete Message Template

  • In the console, click delete button.

[!WARNING|label: Delete] After confirming deletion, the template will not continue to be used. Before deleting the account, make sure that the template is no longer in use by the application.

Edit Message Template

  • In the console, click edit button.

[!WARNING|label: Edit] Templates that have been approved need to be review after content modification, make sure that the template is no longer in use by the application.

Delete Message Signature

  • In the console, click delete button.

[!WARNING|label: Delete] After confirming deletion, the signature will not continue to be used. Before deleting the account, make sure that the signature is no longer in use by the application.

results matching ""

    No results matching ""