创建模板

本接口用于实现创建模板功能。

请求说明

请求地址：https://smssh.253.com/sms/v2/template/add

请求方式、Content-Type、编码格式及公共请求头参数，请参见 API调用说明

请求体参数

名称	类型	必填	描述	示例值
productType	String	是	产品类型：`notify`-通知短信；`market`-营销短信；`verify`-验证码短信；`2ec`-CS短信（二类电商）；`finance`-DK短信（金融）；`game`-BK短信（游戏）；`acquisition`-HK短信（拉新）	`notify`
content	String	是	模板内容，不包含短信签名和退订语，长度不超过500字；包含链接时需在链接前后各加一个空格；变量用 {s} 标识	-
contentName	String	是	模板名称，长度限2-20个字符	-
signName	String	是	关联签名名称	-
needUnsubscribe	String	否	退订语：`0`-不需要；`1`-需要（营销必填）	`0`
businessCategory	String	是	业务大类，从类型枚举接口获取	-
businessSubcategory	String	是	业务细类，从类型枚举接口获取	-
guideUrl	String	否	引流链接(JSON)	-
-guideType	String	否	引流链接类型 - 从类型枚举接口获取（本目录第二个接口的 id 值）	-
-content	String	否	引流链接内容 - 模板内容中包含的引流链接，填写注意事项： - 1、协议头要求：若实际下发含有协议头，必须加上协议头（如 https://api.253.com） - 2、域名要求：必须填写完整域名（如 api.253.com，不能填 253.com） - 3、建议格式：按域名形式报备（如 api.253.com/CDMVKA2v 建议填 api.253.com）	-
-domainExample	String	否	完整链接示例 - 除了填写引流链接外，还需要提供一个完整链接示例，运营商审核需要： - 是短链的话，就填写完整的短链。	-
-icpImg	String	否	域名ICP备案截图(Base64，≤1MB) - 域名ICP备案截图地址：https://beian.miit.gov.cn/%C2%A0/#/Integrated/index）	-
-originLinkAuthImg	String	否	原链接授权书(Base64，≤1MB)	-
-redirectLinkAuthImg	String	否	跳转后链接授权书(Base64，≤1MB)	-
guidePhone	String	否	联系方式 - object[] 类型转成 JSON 字符串传入（支持多个联系方式）	-
-guideType	String	否	联系方式类型 - 从类型枚举接口获取（本目录第二个接口的 id 值）	-
-content	String	否	联系方式内容 - 模板内容中包含的联系方式，填写注意事项： - 引流号码不要带空格或横杠，如 021-123-456 需填 021123456	-
-phoneMaterialImg	String	否	引流号码材料(Base64，≤1MB)	-
variableParams	String	否	变量属性 - object[] 类型转成 JSON 字符串传入 - 运营商建议3个变量，最大不超过20个	-
-name	String	否	变量名称 - 例如：变量1、变量2	-
-type	String	否	变量类型 - 从类型枚举接口获取（本目录第二个接口的 id 值）	-
-length	String	否	变量长度 - 最大支持30位占位	-
-position	Integer	否	变量位置 - 第一个变量=0，第二个=1，第三个=2，以此递增	-
remark	String	否	备注内容 - 描述对审核者的提议，有利于加速模板审核	-

请求示例

{
  "productType": "verify",
  "content": "您的验证码是{s}，请勿泄露。",
  "contentName": "验证码模板",
  "signName": "创蓝253",
  "needUnsubscribe": "0",
  "businessCategory": "1",
  "businessSubcategory": "101",
  "remark": "登录验证码",
  "variableParams": "[{\"name\":\"变量1\",\"type\":\"code\",\"length\":\"6\",\"position\":0}]"
}

响应体参数

名称	类型	说明	示例值
code	String	请求状态码，000000 代表成功，其他为失败	000000
msg	String	提示信息（Unicode，需自行解码）	深度接口新增模板成功
requestId	String	请求id	-
data	Object	返回数据	-
-templateCode	String	模板ID	767669

响应示例

{
  "code": "000000",
  "msg": "成功",
  "data": {
    "templateCode": "100001"
  }
}

产品中心

热门搜索

中国站

国际站

创建模板

创建模板

请求说明

请求体参数

请求示例

响应体参数

响应示例