添加短信模板

更新时间:2023-06-15 05:31:57

本文介绍添加短信模板的 API。

接口描述

增加短信模版,即具体发送的短信内容,可以支持验证码、短信通知、推广短信三种模式。验证码和短信通知,通过变量替换实现个性短信定制。

接口地址

POST: /v1.0/iot-03/msg-templates/sms

请求参数

body 说明

参数名 类型 参数位置 是否必填 说明
name String true 模板名称,长度为1~30 个字符
content String true 模板内容,长度为1~500 个字符
type Integer true 短信类型,0:验证码,1:短信通知,2:推广短信
remark String true 短信模板申请说明,请在申请说明中描述您的业务使用场景,长度为 1~100个字符

返回参数

参数名 类型 说明
result MsgTemplatesRes

result 说明

参数名 类型 说明
template_id String 模板 ID。返回的模板 ID 审核通过后才会生效,请耐心等待审核结果。

请求示例

POST: /v1.0/iot-03/msg-templates/sms
{ "name": "短信验证码模板", "content": "您正在申请手机注册,验证码为:${code},5分钟内有效!", "type": 0, "remark": "当前的短信模板应用于注册场景" }

返回示例

{ "result": { "template_id": "SMS_1616396456" }, "t": 1586153261345, "success": true }

错误码

参考 错误码