接口请求域名： sms.intl.tencentcloudapi.com 。
- 注：由于云 API3.0 安全性有所提升，所以接口鉴权较为复杂，建议使用 SDK 来使用云短信服务。
- 您可以在 API 3.0 Explorer 中直接运行该接口，可以先免去签名计算步骤。运行成功后，API Explorer可以自动生成SDK代码示例。
默认接口请求频率限制：1次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：AddSmsSign。 |
| Version | 是 | String | 公共参数，本接口取值：2021-01-11。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| SignName | 是 | String | 签名名称。 |
| SignType | 是 | Integer | 签名类型。其中每种类型后面标注了其可选的 DocumentType（证明类型）： |
| DocumentType | 是 | Integer | 证明类型： |
| International | 是 | Integer | 是否国际/港澳台短信： |
| SignPurpose | 是 | Integer | 签名用途： |
| ProofImage | 是 | String | 签名对应的资质证明图片需先进行 base64 编码格式转换，将转换后的字符串去掉前缀 |
| CommissionImage | 否 | String | 委托授权证明。选择 SignPurpose 为他用之后需要提交委托的授权证明。 |
| Remark | 否 | String | 签名的申请备注。 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| AddSignStatus | AddSignStatus | 添加签名响应 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
POST / HTTP/1.1
Host: sms.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AddSmsSign
<公共请求参数>
{
"Remark": "业务自用申请",
"SignPurpose": 0,
"SignType": 0,
"CommissionImage": "base64",
"SignName": "腾讯云",
"DocumentType": 1,
"International": 0,
"ProofImage": "base64"
}
{
"Response": {
"AddSignStatus": {
"SignId": 1110
},
"RequestId": "f36e4f00-605e-49b1-ad0d-bfaba81c7325"
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.FailResolvePacket | 请求包解析失败，通常情况下是由于没有遵守 API 接口说明规范导致的，请参考 请求包体解析1004错误详解。 |
| FailedOperation.JsonParseFail | 解析请求包体时候失败。 |
| FailedOperation.NotEnterpriseCertification | 非企业认证无法使用签名及模板相关接口，您可以 变更实名认证模式，变更为企业认证用户后，约1小时左右生效。 |
| FailedOperation.OtherError | 其他错误，一般是由于参数携带不符合要求导致，请参考API接口说明，如有需要请联系 腾讯云短信小助手。 |
| FailedOperation.ParametersOtherError | 未知错误，如有需要请联系 腾讯云短信小助手。 |
| FailedOperation.QualificationIdNotApproved | 资质ID未审核通过。资质 ID 信息可前往国内短信的 实名资质管理 页查看。 |
| FailedOperation.SignNumberLimit | 签名个数达到最大值。 |
| FailedOperation.TemplateIdNotExist | 模板 ID 不存在。 |
| InternalError.RequestTimeException | 请求发起时间不正常，通常是由于您的服务器时间与腾讯云服务器时间差异超过10分钟导致的，请核对服务器时间及 API 接口中的时间字段是否正常。 |
| InternalError.RestApiInterfaceNotExist | 不存在该 RESTAPI 接口，请核查 REST API 接口说明。 |
| InternalError.SigFieldMissing | 后端包体中请求包体没有 Sig 字段或 Sig 为空。 |
| InternalError.SigVerificationFail | 后端校验 Sig 失败。 |
| InternalError.Timeout | 请求下发短信超时，请参考 60008错误详解。 |
| InternalError.UnknownError | 未知错误类型。 |
| InvalidParameter.AppidAndBizId | 账号与应用id不匹配。 |
| InvalidParameterValue.ImageInvalid | 上传的转码图片格式错误，请参照 API 接口说明中对该字段的说明，如有需要请联系 腾讯云短信小助手。 |
| InvalidParameterValue.InvalidDocumentType | DocumentType 字段校验错误，请参照 API 接口说明中对该字段的说明，如有需要请联系 腾讯云短信小助手。 |
| InvalidParameterValue.InvalidInternational | International 字段校验错误，请参照 API 接口说明中对该字段的说明，如有需要请联系 腾讯云短信小助手。 |
| InvalidParameterValue.InvalidUsedMethod | UsedMethod 字段校验错误，请参照 API 接口说明中对该字段的说明，如有需要请联系 腾讯云短信小助手。 |
| InvalidParameterValue.QualificationIdNotFound | 资质ID未找到。资质 ID 信息可前往国内短信的 实名资质管理 页查看。 |
| InvalidParameterValue.SdkAppIdNotExist | SdkAppId 不存在。 |
| InvalidParameterValue.SignAlreadyPassedCheck | 此签名已经通过审核，无法再次进行修改。 |
| InvalidParameterValue.SignExistAndUnapproved | 已存在相同的待审核签名。 |
| InvalidParameterValue.SignNameLengthTooLong | 签名内容长度过长。 |
| MissingParameter | 缺少参数错误。 |
| UnauthorizedOperation.RequestIpNotInWhitelist | 请求 IP 不在白名单中，您配置了校验请求来源 IP，但是检测到当前请求 IP 不在配置列表中，如有需要请联系 腾讯云短信小助手。 |
| UnauthorizedOperation.RequestPermissionDeny | 请求没有权限，请联系 腾讯云短信小助手。 |
| UnauthorizedOperation.ServiceSuspendDueToArrears | 欠费被停止服务，可自行登录腾讯云充值来缴清欠款。 |
| UnsupportedOperation | 操作不支持。 |
文档反馈