文档首页/ 消息通知服务 SMN/ API参考 (巴黎区域)/ API/ 模板操作/ 创建消息模板
更新时间：2024-03-13 GMT+08:00
在线调试
CLI示例
查看PDF
分享

创建消息模板

功能介绍

创建一个模板，用户可以按照模板去发送消息，这样可以减少请求的数据量。 单用户默认可创建100个消息模板，高并发场景下，可能会出现消息模板数量超过100仍创建成功的情况，此为正常现象。

调用方法

请参见如何调用API。

URI

POST /v2/{project_id}/notifications/message_template

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。获取项目ID请参考 获取项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

message_template_name

是

String

创建模板的名称。只能包含大写字母、小写字母、数字、-和_，且必须由大写字母、小写字母或数字开头，长度在1到64个字符之间。

protocol

是

String

模板支持的协议类型。

目前支持的协议包括：

“default”：默认协议。

“email”：邮件传输协议。

“sms”：短信传输协议。

“functionstage”：FunctionGraph（函数）传输协议。

“dms”：DMS传输协议。

“http”、“https”：HTTP/HTTPS传输协议。

content

是

String

模板内容，模板目前仅支持纯文本模式。模板内容不能空，最大支持256KB。

响应参数

状态码： 201

表4 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

message_template_id

String

模板唯一的资源标识。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码： 403

表6 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码： 404

表7 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

状态码： 500

表8 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

code

String

服务异常错误信息编码。

message

String

服务异常错误信息描述。

请求示例

创建模板名称为confirm_message，且模板支持的协议类型为https的消息模板

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.)"
}

响应示例

状态码： 201

OK

{
  "request_id" : "6a63a18b8bab40ffb71ebd9cb80d0085",
  "message_template_id" : "57ba8dcecda844878c5dd5815b65d10f"
}

状态码

状态码

描述

201

OK

400

Bad Request

403

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 模板操作