# 申请短信模板 - CreateUSMSTemplate

## 简介

调用接口CreateUSMSTemplate申请短信模板

 > 💡 您可以通过调用接口CreateUSMSTemplate或者到控制台申请短信模板，短信模板需遵守 [UCloud服务协议](https://docs.ucloud.cn/management_monitor/usms/introduction/service_level)，短信模板申请流程可参见官网 [短信模板审核规范](https://docs.ucloud.cn/management_monitor/usms/introduction/2005/2103) 说明；



## 定义

### 公共参数

| 参数名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **Action**     | string  | 对应的 API 指令名称，当前 API 为 `CreateUSMSTemplate`                        | **Yes** |
| **PublicKey**  | string  | 用户公钥，可从 [控制台](https://console.genesissai.com/uaccount/api_manage) 获取                                             | **Yes** |
| **Signature**  | string  | 根据公钥及 API 指令生成的用户签名，参见 [签名算法](/docs/api/summary/signature.md)  | **Yes** |

### 请求参数

| 参数名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **ProjectId** | string | 项目ID，不填写为默认项目，子帐号必须填写。 请参考[GetProjectList接口](/docs/api/summary/get_project_list) |**Yes**|
| **Purpose** | int | 短信模板用途类型：1-验证码类短信模板；2-系统通知类短信模板；3-会员推广类短信模板； |**Yes**|
| **TemplateName** | string | 短信模板名称，不超过32个字符，每个中文、符号、英文、数字等都计为1个字。 |**Yes**|
| **Template** | string | 短信模板内容，说明如下：字数不超过500，每个中文、符号、英文、数组等都计为一个字；模板中的变量填写格式：{N}，其中N为大于1的整数，有多个参数时，建议N从1开始顺次，例如：{1}、{2}等；短信模板禁止仅包括变量的情况； |**Yes**|
| **International** | boolean | 标记是否为国际短信。true:国际短信，false:国内短信，若不传值则默认该值为false |No|
| **Remark** | string | 短信模板申请原因说明，字数不超过128，每个中文、符号、英文、数字等都计为1个字。 |No|
| **UnsubscribeInfo** | string | 当Purpose=3并且International=false时，也即国内会员推广类短信模板，该项必填。枚举值：【拒收请回复R】 |No|
| **Instruction** | string | 模板变量属性说明 |No|

### 响应字段

| 字段名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **RetCode** | int | 返回状态码，为 0 则为成功返回，非 0 为失败 |**Yes**|
| **Action** | string | 操作指令名称 |**Yes**|
| **Message** | string | 返回错误消息，当 `RetCode` 非 0 时提供详细的描述信息 |No|
| **TemplateId** | string | 短信模板ID（短信模板申请时的工单ID） |**Yes**|




## 示例

### 请求示例
    
```
https://api.genesissai.com/?Action=CreateUSMSTemplate
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=nwkzSZQY
&Purpose=1
&TemplateName=vnSDFAjK
&Template=ulaAspXU
&International=true
&Remark=eGfxoirr
&UnsubscribeInfo=LJlQORyc
&Instruction=fotdmkKB
```

### 响应示例
    
```json
{
  "Action": "CreateUSMSTemplateResponse",
  "Message": "iUdpztgk",
  "RetCode": 0,
  "TemplateId": "edcONjeS"
}
```