创建短信模板
功能介绍
该接口用于用户创建短信模板。
URI
POST /v1/sms/templates
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
|
Content-Type |
是 |
String |
请求体参数类型，该字段必须设置为：application/json。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
app_id |
否 |
String |
应用ID，默认取签名所属的应用ID。 最小长度：1 最大长度：50 |
|
signature_id |
是 |
String |
签名ID。 最小长度：1 最大长度：50 |
|
template_content |
是 |
String |
模板内容。 最小长度：1 最大长度：500 |
|
template_desc |
否 |
String |
模板描述。 最小长度：1 最大长度：100 |
|
template_name |
是 |
String |
模板名称。 最小长度：1 最大长度：30 |
|
template_type |
否 |
String |
模板类型。默认取所属签名的签名类型。 最小长度：1 最大长度：20 枚举值：
|
|
universal_template |
否 |
String |
是否为通用模板(暂不支持通用模板)。 缺省值：0 最小长度：1 最大长度：10 枚举值：
|
|
variable_attributes |
是 |
Array of VariableAttributes objects |
模板参数。 数组长度：1 - 20 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
template_id |
String |
模板ID。 最小长度：1 最大长度：50 |
|
template_name |
String |
模板名称。 最小长度：1 最大长度：30 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
结果状态码。 最小长度：0 最大长度：32 |
|
error_msg |
String |
结果详情。 最小长度：0 最大长度：32 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
结果状态码。 最小长度：0 最大长度：32 |
|
error_msg |
String |
结果详情。 最小长度：0 最大长度：32 |
请求示例
创建一个名称为"模板测试AA"，类型为通知类的短信模板。
https://koomessage.myhuaweicloud.cn/v1/sms/templates
{
"signature_id" : "65ba0c56-aa84-4e68-86a7-38af62c50707",
"template_content" : "尊敬的华为云会员，详情请咨询4000-955**** ${1} ",
"template_desc" : "模板测试",
"template_name" : "模板测试AA",
"template_type" : "NOTIFY_TYPE",
"universal_template" : 0,
"variable_attributes" : [ {
"variable_index" : 1,
"variable_type" : "NEWTEXT",
"variable_desc" : "直发"
} ]
}
响应示例
状态码： 200
创建短信模板响应体。
{
"template_id" : "1512***2",
"template_name" : "模板测试AA"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
创建短信模板响应体。 |
|
400 |
非法参数。 |
|
500 |
内部错误。 |
错误码
请参见错误码。
