有奖:文档满意度调查问卷,诚邀您填写> HOT

1. 接口描述

接口请求域名: sms.tencentcloudapi.com 。

  1. 添加短信签名,申请之前请先认真参阅 腾讯云短信签名审核标准
  2. ⚠️注意:个人认证用户不支持使用 API 申请短信签名,请参阅了解 实名认证基本介绍,如果为个人认证请登录控制台申请短信签名。
    • 注:由于云 API3.0 安全性有所提升,所以接口鉴权较为复杂,建议使用 SDK 来使用云短信服务。
    • 您可以在 API 3.0 Explorer 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以自动生成SDK代码示例。

默认接口请求频率限制:1次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:AddSmsSign。
Version String 公共参数,本接口取值:2021-01-11。
Region String 公共参数,详见产品支持的 地域列表
SignName String 签名名称。
注:不能重复申请已通过或待审核的签名。
示例值:腾讯云
SignType Integer 签名类型。其中每种类型后面标注了其可选的 DocumentType(证明类型):
0:公司,可选 DocumentType 有(0,1)。
1:APP,可选 DocumentType 有(0,1,2,3,4) 。
2:网站,可选 DocumentType 有(0,1,2,3,5)。
3:公众号,可选 DocumentType 有(0,1,2,3,8)。
4:商标,可选 DocumentType 有(7)。
5:政府/机关事业单位/其他机构,可选 DocumentType 有(2,3)。
6:小程序,可选 DocumentType 有(0,1,2,3,6)。
注:必须按照对应关系选择证明类型,否则会审核失败。
示例值:0
DocumentType Integer 证明类型:
0:三证合一。
1:企业营业执照。
2:组织机构代码证书。
3:社会信用代码证书。
4:应用后台管理截图(个人开发APP)。
5:网站备案后台截图(个人开发网站)。
6:小程序设置页面截图(个人认证小程序)。
7:商标注册书。
8:公众号设置页面截图(个人认证公众号)。
示例值:1
International Integer 是否国际/港澳台短信:
0:表示国内短信。
1:表示国际/港澳台短信。
示例值:0
SignPurpose Integer 签名用途:
0:自用。
1:他用。
示例值:0
ProofImage String 签名对应的资质证明图片需先进行 base64 编码格式转换,将转换后的字符串去掉前缀data:image/jpeg;base64,再赋值给该参数。
示例值:base64
CommissionImage String 委托授权证明。选择 SignPurpose 为他用之后需要提交委托的授权证明。
图片需先进行 base64 编码格式转换,将转换后的字符串去掉前缀data:image/jpeg;base64,再赋值给该参数。
注:只有 SignPurpose 在选择为 1(他用)时,这个字段才会生效。
示例值:base64
Remark String 签名的申请备注。
示例值:业务自用申请

3. 输出参数

参数名称 类型 描述
AddSignStatus AddSignStatus 添加签名响应
示例值:{"SignId":1110}
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

输入示例

POST / HTTP/1.1
Host: sms.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"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

签名demo

下面提供了各个语言生成签名的过程,demo 只是起到演示的作用,不具备通用性,在实际的开发中还是推荐使用 SDK。

Signature V1:

Signature V3

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.FailResolvePacket 请求包解析失败,通常情况下是由于没有遵守 API 接口说明规范导致的,请参考 请求包体解析1004错误详解
FailedOperation.JsonParseFail 解析请求包体时候失败。
FailedOperation.NotEnterpriseCertification 非企业认证无法使用签名及模板相关接口,您可以 变更实名认证模式,变更为企业认证用户后,约1小时左右生效。
FailedOperation.OtherError 其他错误,一般是由于参数携带不符合要求导致,请参考API接口说明,如有需要请联系 腾讯云短信小助手
FailedOperation.ParametersOtherError 未知错误,如有需要请联系 腾讯云短信小助手
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.SdkAppIdNotExist SdkAppId 不存在。
InvalidParameterValue.SignAlreadyPassedCheck 此签名已经通过审核,无法再次进行修改。
InvalidParameterValue.SignExistAndUnapproved 已存在相同的待审核签名。
InvalidParameterValue.SignNameLengthTooLong 签名内容长度过长。
MissingParameter 缺少参数错误。
UnauthorizedOperation.RequestIpNotInWhitelist 请求 IP 不在白名单中,您配置了校验请求来源 IP,但是检测到当前请求 IP 不在配置列表中,如有需要请联系 腾讯云短信小助手
UnauthorizedOperation.RequestPermissionDeny 请求没有权限,请联系 腾讯云短信小助手
UnauthorizedOperation.ServiceSuspendDueToArrears 欠费被停止服务,可自行登录腾讯云充值来缴清欠款。
UnsupportedOperation. 不支持该请求。