Template and Variable Specifications
A template consists of fixed text and variables or only fixed text. You can edit template content based on your service requirements and can only send SMSs with approved templates. The variables change according to SMS content.
Apply for several SMS templates in advance according to service requirements and reserve sufficient time for review. Templates can be reviewed only on workdays.
Read the following specifications and mak sure that your SMS templates comply with the common specifications and special specifications of each template type.
Common Specifications
Template Specifications
Format |
Each template contains no more than 500 characters.
|
---|---|
Content |
Fixed texts in a template must be able to denote the meaning and application scenario of the SMS. Use as many fixed texts as possible.
|
Variable Specifications
Each template can contain a maximum of 20 variables. Continuous variables or full-variable templates are not supported. (If characters not containing spaces exist between variables, the variables are discontinuous.)
Note: If you need to extend the variable length, describe your service scenario with examples and reasons for variable extension and specify the variable to be extended and desired length when applying for an SMS template.
The system supports variables listed in the following table. You can choose a proper variable format and length.
Variable Format |
Type |
Example Value |
Description |
---|---|---|---|
${TXT_Digit} |
Character |
${TXT_20} |
Digit indicates the maximum length. The value can be 1 to 20. Each non-English character is counted as two bytes. Each English letter, digit, or punctuation mark is counted as one byte. Set this parameter based on the site requirements. Do not set this parameter to a large value.
NOTICE:
|
${NUM_Digit} |
Digit |
${NUM_6} |
Digit indicates the maximum length. The value can be 1 to 20. One digit is counted as one character. When sending an SMS, enter a number ranging from 0 to 9. The number cannot contain other characters, such as hyphens (-). Set this parameter based on the site requirements. Do not set this parameter to a large value. |
${DATE} |
Date |
${DATE} |
The date in an SMS is in yyyy/MM/dd format, for example, 2017/07/16, 2017/7/16, or 2017/7/1. |
${TIME} |
Time |
${TIME} |
The system supports the following time formats:
|
Specifications for Each Template Type
In addition to the common specifications, each template type has the following specifications:
Category |
Variable Specifications |
Content Specifications |
---|---|---|
Verification code template |
|
- |
Notification template |
The link and contact information cannot be sent using variables. Enter the link and contact information using fixed texts in the template. |
Marketing promotional information is not allowed. |
- The template specifications may be adjusted in real time based on the carrier's rules. The final template review result prevails.
- If your violation causes bad influence, serious measures will be taken and your account will be blocked. Strictly comply with the specifications to enhance service security.
Template Review Description
The common issues of all template types are as follows:
Type |
Level-1 Issue |
Level-2 Issue |
Handling Suggestion |
Invalid Template Example |
Valid Template Example |
---|---|---|---|---|---|
The application is incorrect. |
The SMS type is incorrect. |
The verification code type is mistakenly selected for notification SMSs. |
Select a proper SMS type based on the SMS content. |
- |
For more examples, see Sample Template. |
The format is incorrect. |
Variables are incorrect. |
The number of variables is incorrect. |
Consecutive variables are not supported. The total number of variables cannot exceed 20. |
Reminder: The meeting at ${DATE} ${TIME}${TIME}${NUM_6}${TXT_20} is about to start. Join the conference on time. |
Reminder: The conference at ${DATE} - ${TIME} is about to start. Join the conference on time. |
The variable value is incorrect. |
|
Your verification code is ${NUM_7}. It is valid for 5 minutes. Do not provide this verification code to anyone. |
Your verification code is ${NUM_6}. It is valid for 5 minutes. Do not provide this verification code to anyone. |
||
The variable format is incorrect. |
The following variable formats are supported by templates:
|
Your verification code is ${1}. It is valid for 5 minutes. Do not provide it to anyone. |
Your verification code is ${NUM_6}. It is valid for 5 minutes. Do not provide it to anyone. |
||
The SMS content is incorrect. |
The SMS content contains forbidden symbols. |
Special characters (¥★^_^&√) are not supported. |
|
Reminder: The conference at ${DATE} & ${TIME} is about to start. Join the conference on time. |
Reminder: The conference at ${DATE} -${TIME} is about to start. Join the conference on time. |
The variable is incorrectly used. |
${DATE}${TIME} is not used for time, and ${NUM_Digit} is not used for numbers. |
Select variables based on the actual SMS content. Do not randomly use TXT variables. |
Reminder: The conference at ${NUM_6} & ${TXT_5} is about to start. Join the conference on time. |
Reminder: The conference at ${DATE} -${TIME} is about to start. Join the conference on time. |
|
The SMS content is not clear. |
A full variable template contains few fixed texts and many variables. Variable values are too large. Service scenarios cannot be identified. |
The full variable template is not supported. You can set variables as required and use as much fixed text as possible so that the meaning and application scenario of the SMS can be understood. |
${DATE} ${TIME} - ${TIME} of ${TXT_12} |
Reminder: The conference at {DATE}- ${TIME} is about to start. Join the conference on time. |
|
The template lacks mandatory keywords. |
A verification code SMS template must contain any of the verification code, registration code, and dynamic code. |
Add a required keyword. |
${NUM_6}. It is valid for 5 minutes. Do not provide it to anyone. |
Your verification code is ${NUM_6}. It is valid for 5 minutes. Do not provide it to anyone. |
The following table lists the special issues of different types of templates:
Type |
Level-1 Issue |
Level-2 Issue |
Handling Suggestion |
Invalid Template Example |
Valid Template Example |
---|---|---|---|---|---|
Verification code |
The template contains forbidden content. |
The verification code template contains marketing content. |
Delete the content that is not related to verification code. |
Your verification code is ${NUM_6}. It is valid for 5 minutes. Log in to collect your coupons! |
Your verification code is ${NUM_6}. It is valid for 5 minutes. Do not provide this verification code to anyone. |
The template contains other variables. |
There are other long variables in addition to the verification code. |
Do not set other content in an SMS as variables. If verification codes are of multiple types, such as registration and password change, you can apply for different templates separately. |
Your verification code is ${NUM_6}. It is valid for 5 minutes and is used only for ${TXT_20}. |
Your verification code is ${NUM_6}. It is valid for 5 minutes. Do not provide this verification code to anyone. |
|
Notification |
Recruitment and interview notifications are not supported. |
- |
Do not send recruitment and interview notifications. |
Dear XX, this is a reminder for the first round of interview on ${DATE} in ${TXT_20}. Please prepare related documents. |
For more examples, see Sample Template. |
Notifications on games, finance, real estate, and education are not supported. |
- |
Do not send game, real estate, and financial notifications. |
Log in to the XX game to collect rewards. |
For more examples, see Sample Template. |
|
Dunning notifications are not supported. |
- |
Do not send dunning and payment notifications. |
Amount due: CNY${NUM_6}. Due date: 8th of this month. |
For more examples, see Sample Template. |
|
Notifications contain marketing information. |
The first part of the SMS is the notification, and the second part is marketing information. |
Do not include marketing information in notification SMSs. You can modify the template content based on the review comments returned by the platform. |
You have booked ${NUM_6} tickets. Ticket password: ${NUM_6}. Please arrive in advance. Follow the XX official account to obtain more travel information. |
You have booked ${NUM_6} tickets. Ticket password: ${NUM_6}. Please arrive in advance. |
|
SMSs contain other content forbidden by rules. |
Notification SMSs contain the content (such as coupons) forbidden by template specifications. |
|
Follow ${NUM_10} to collect the coupon for the XX product. |
For more examples, see Sample Template. |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot