1. 接口描述
接口请求域名: sms.tencentcloudapi.com 。
本接口 (AddSmsTemplate) 用于创建短信模板。
说明:
- 申请短信模板前,请先认真参阅 腾讯云短信正文模板审核标准。
- 个人认证用户不支持使用 API 申请短信正文模板,请参阅了解 实名认证基本介绍,如果为个人认证请登录 控制台 申请短信正文模板。
默认接口请求频率限制:2次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:AddSmsTemplate。 |
Version | 是 | String | 公共参数,本接口取值:2019-07-11。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
TemplateName | 是 | String | 模板名称。 示例值:验证码 |
TemplateContent | 是 | String | 模板内容。 示例值:您的验证码是{1} |
SmsType | 是 | Integer | 短信类型,1表示营销短信,2表示通知短信,3表示验证码短信。 注:为进一步提升短信发送质量、提高短信模板审核通过率,从2024年5月16日起,腾讯云短信模板类型优化为“验证码短信”、“通知短信”、“营销短信”,可参考关于腾讯云短信模板类型优化公告。新开通短信服务的客户需严格参考新的短信类型申请短信模板。 示例值:3 |
International | 是 | Integer | 是否国际/港澳台短信: 0:表示国内短信。 1:表示国际/港澳台短信。 示例值:0 |
Remark | 是 | String | 模板备注,例如申请原因,使用场景等。 示例值:业务验证码 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
AddTemplateStatus | AddTemplateStatus | 添加短信模板响应包体 示例值:{"TemplateId":"1110"} |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求示例
输入示例
POST / HTTP/1.1
Host: sms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AddSmsTemplate
<公共请求参数>
{
"SmsType": 3,
"International": 0,
"Remark": "test",
"TemplateContent": "your code is {1}",
"TemplateName": "腾讯云"
}
输出示例
{
"Response": {
"AddTemplateStatus": {
"TemplateId": "1110"
},
"RequestId": "f36e4f00-605e-49b1-ad0d-bfaba81c7325"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
签名demo
下面提供了各个语言生成签名的过程,demo 只是起到演示的作用,不具备通用性,在实际的开发中还是推荐使用 SDK。
Signature V1:
- Signature V1 demo for Python
- Signature V1 demo for Java
- Signature V1 demo for PHP
- Signature V1 demo for Go
- Signature V1 demo for NodeJS
- Signature V1 demo for .NET
Signature V3
- Signature V3 demo for Python
- Signature V3 demo for Java
- Signature V3 demo for PHP
- Signature V3 demo for Go
- Signature V3 demo for NodeJS
- Signature V3 demo for .NET
- Signature V3 demo for C++
- Signature V3 demo for Ruby
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.FailResolvePacket | 请求包解析失败,通常情况下是由于没有遵守 API 接口说明规范导致的,请参考 请求包体解析1004错误详解。 |
FailedOperation.JsonParseFail | 解析请求包体时候失败。 |
FailedOperation.MissingSignature | 没有申请签名之前,无法申请模板,请根据 创建签名 申请完成之后再次申请。 |
FailedOperation.MissingTemplateToModify | 此模板 ID 未提交申请或不存在,不能进行修改操作,请检查您的 TemplateId是否填写正确。 |
FailedOperation.NotEnterpriseCertification | 非企业认证无法使用签名及模板相关接口,您可以 变更实名认证模式,变更为企业认证用户后,约1小时左右生效。 |
FailedOperation.OtherError | 其他错误,一般是由于参数携带不符合要求导致,请参考API接口说明,如有需要请联系 腾讯云短信小助手。 |
FailedOperation.TemplateAlreadyPassedCheck | 此模板已经通过审核,无法再次进行修改。 |
FailedOperation.TemplateNumberLimit | 模板个数达到最大值。 |
InternalError.JsonParseFail | 解析用户参数失败,可联系 腾讯云短信小助手。 |
InternalError.OtherError | 其他错误,请联系 腾讯云短信小助手 并提供失败手机号。 |
InternalError.ParseBackendResponseFail | 解析运营商包体失败,可联系 sms helper 。 |
InternalError.RequestTimeException | 请求发起时间不正常,通常是由于您的服务器时间与腾讯云服务器时间差异超过10分钟导致的,请核对服务器时间及 API 接口中的时间字段是否正常。 |
InternalError.RestApiInterfaceNotExist | 不存在该 RESTAPI 接口,请核查 REST API 接口说明。 |
InternalError.SendAndRecvFail | 接口超时或短信收发包超时,请检查您的网络是否有波动,或联系 腾讯云短信小助手 解决。 |
InternalError.SigVerificationFail | 后端校验 Sig 失败。 |
InternalError.Timeout | 请求下发短信超时,请参考 60008错误详解。 |
InternalError.UnknownError | 未知错误类型。 |
InvalidParameter.InvalidParameters | 参数有误,如有需要请联系 腾讯云短信小助手。 |
InvalidParameterValue.InvalidInternational | International 字段校验错误,请参照 API 接口说明中对该字段的说明,如有需要请联系 腾讯云短信小助手。 |
InvalidParameterValue.InvalidSmsType | SmsType 字段校验错误,请参照 API 接口说明中对该字段的描述,更多疑问可咨询 腾讯云短信小助手。 |
InvalidParameterValue.MarketingTemplateWithoutUnsubscribe | 营销短信必须包含退订方式,请在短信模板尾部添加“拒收请回复R”后提交。可参考 关于营销短信退订标识修改的公告。 |
InvalidParameterValue.UnsupportedTemplateVariable | 申请国内短信通知和营销短信模板不支持添加变量。可参考 控制台说明,更多疑问可咨询 腾讯云短信小助手 |
UnauthorizedOperation.RequestIpNotInWhitelist | 请求 IP 不在白名单中,您配置了校验请求来源 IP,但是检测到当前请求 IP 不在配置列表中,如有需要请联系 腾讯云短信小助手。 |
UnauthorizedOperation.RequestPermissionDeny | 请求没有权限,请联系 腾讯云短信小助手。 |
UnauthorizedOperation.SdkAppIdIsDisabled | 此 SdkAppId 禁止提供服务,如有需要请联系 腾讯云短信小助手。 |
UnauthorizedOperation.ServiceSuspendDueToArrears | 欠费被停止服务,可自行登录腾讯云充值来缴清欠款。 |
UnsupportedOperation | 操作不支持。 |