文档首页/ 消息&短信 MSGSMS/ API参考/ API/ 应用、签名、模板/ 短信模板/ 创建短信模板
更新时间：2024-08-06 GMT+08:00
查看PDF
分享

创建短信模板

功能介绍

该接口用于用户创建模板。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v2/{project_id}/msgsms/templates

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，参考“获取帐号、用户、项目的名称和ID”

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

请求体参数类型，该字段必须设置为：application/json

X-Auth-Token

是

String

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

参数

是否必选

参数类型

描述

app_id

是

String

应用主键ID，参考表5 响应SmsAppQueryResp参数中的id

brackets

否

String

中括号类型。支持枚举值：

  • CN：中文类型：【】
  • GB：英文类型： []
    须知：
    • 默认值为：CN
    • 输入值不在上述枚举值范围内的，也按CN处理。
    • 只有地域为国内时，该字段有效。

region

是

String

地域

  • cn：国内
  • intl：国际

send_country

否

Array of Integers

发送国家id列表，只有地域为国际时，该字段有效

sign_id

否

String

签名主键id，对应表5 响应SmsSignatureResp参数中的ID。只有地域为国内时，该字段有效

template_content

是

String

模板内容

template_desc

否

String

模板描述

template_name

是

String

模板名称

template_type

是

String

模板类型。只有地域为国内时，该字段有效。支持枚举值：

  • VERIFY_CODE_TYPE: 验证码类
  • PROMOTION_TYPE: 推广类
  • NOTIFY_TYPE: 通知类

universal_template

否

Integer

是否为通用模板

  • 0: 非通用模板
  • 1: 通用模板

variable_attributes

否

Array of SmsTemplateVariableAttrReq objects

模板参数
表4 SmsTemplateVariableAttrReq

参数

是否必选

参数类型

描述

variable_desc

否

String

变量说明，当变量类型为TEXT时，必填

variable_index

是

Integer

变量索引，对应模板内容变量索引

variable_type

是

String

变量类型，目前支持：PHONE|CHARDIGIT|DATETIME|MONEY|TEXT

响应参数

表5 响应Body参数

参数

参数类型

描述

id

String

模板主键ID

template_name

String

模板名称

请求示例

创建短信模板，请求方式：POST ，请求URL：/v2/{project_id}/msgsms/templates，路径参数：project_id，请求头参数：X-Auth-Token，Content-Type；请求体：app_id，region，template_content，template_type，template_name。

POST /v2/845ada5bc7444f1295cd517af0123da1/msgsms/templates 
Host: 100.85.***.***:30300
Content-Type: application/json
X-Auth-Token: ****
Content-Length: 308
 
{
    "app_id": "******9c-1a6b-4ee5-9651-5bca450694b3",
    "brackets": "GB",
    "region": "cn",
    "sign_id": "******10-c3fb-427e-965c-a98ae844c5bd",
    "template_content": "测试",
    "template_name": "auto_test789",
    "template_type": "NOTIFY_TYPE",
    "universal_template": 0
}

响应示例

{
    "id": "******27-37eb-4229-bee9-0eba4d8a897f",
    "template_name": "auto_test789"
}

返回值

状态码

描述

200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

500

System error
父主题： 短信模板

相关文档