Creating a Message Template¶
Description¶
API name
CreateMessageTemplate
Function
Create a message template for quick message sending to reduce the request data volume.
By default, a user can create a maximum of 100 message templates. However, in a high-concurrency scenario, which is rare, extra templates may be successfully created.
Message templates are identified by name, but you can create different templates with the same name as long as they are configured for different protocols. All template messages must include a Default template or they cannot be sent out. The Default template is used anytime a template has not been configured for a given protocol, but as long as there is a template for the protocol, then any subscriber who selected that protocol when they subscribed will receive a message using the corresponding template.
URI¶
URI format
POST /v2/{project_id}/notifications/message_template
Parameter description
Parameter
Mandatory
Type
Description
project_id
Yes
String
Project ID
Request¶
Parameter description
Parameter
Mandatory
Type
Description
message_template_name
Yes
String
Template name
Enter 1 to 64 characters, and start with a letter or digit. Only letters, digits, hyphens (-), and underscores (_) are allowed.
content
Yes
String
Template content, which currently supports plain text only
The template content cannot be left blank or larger than 256 KB.
protocol
Yes
String
Protocol supported by the template
Currently, the following protocols are supported:
email
default
sms
http and https
Example request
POST https://{SMN_Endpoint}/v2/{project_id}/notifications/message_template{ "message_template_name": "confirm_message", "protocol": "https", "content": "(1/2)You are invited to subscribe to topic({topic_id}). Click the following URL to confirm subscription:(If you do not want to subscribe to this topic, ignore this message.)" }
Response¶
Parameter description
Parameter
Type
Description
request_id
String
Request ID, which is unique
message_template_id
String
Resource identifier of the template, which is unique
Example response
{ "request_id": "ca03efa691624d8eb2dfeba01a1bcf6e", "message_template_id": "57ba8dcecda844878c5dd5815b65d10f" }
Returned Value¶
See Returned Value.
Error Codes¶
See Error Codes.