短信
视频服务与安全产品捉虫活动邀您参加！> HOT
文档中心>短信

修改短信签名

最近更新时间：2024-10-16 01:23:57

我的收藏

本页目录：

1. 接口描述

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

本接口 (ModifySmsSign) 用于修改短信签名。

说明：

  • 修改短信签名前，请先认真参阅 腾讯云短信签名审核标准。
  • 个人认证用户不支持使用 API 修改短信签名，请参阅了解 实名认证基本介绍，如果为个人认证请登录 控制台 修改短信签名。
  • 修改短信签名，仅当签名为待审核或已拒绝状态时，才能进行修改，已审核通过的签名不支持修改。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：ModifySmsSign。
Version 是 String 公共参数，本接口取值：2019-07-11。
Region 否 String 公共参数，本接口不需要传递此参数。
SignId 是 Integer 待修改的签名 ID。
示例值：1110
SignName 是 String 签名名称。
示例值：test
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：表示国际/港澳台短信。
注：需要和待修改签名International值保持一致，该参数不能直接修改国内签名到国际签名。
示例值：0
UsedMethod 是 Integer 签名用途：
0：自用。
1：他用。
示例值：1
ProofImage 是 String 签名对应的资质证明图片需先进行 base64 编码格式转换，将转换后的字符串去掉前缀data:image/jpeg;base64,再赋值给该参数。
示例值：base64
CommissionImage 否 String 委托授权证明。选择 UsedMethod 为他用之后需要提交委托的授权证明。
图片需先进行 base64 编码格式转换，将转换后的字符串去掉前缀data:image/jpeg;base64,再赋值给该参数。
注：只有 UsedMethod 在选择为 1（他用）时，这个字段才会生效。
示例值：base64
Remark 否 String 签名的申请备注。
示例值：测试使用

3. 输出参数

参数名称 类型 描述
ModifySignStatus ModifySignStatus 修改签名响应
示例值：{"SignId":1110,"SignApplyId":"1109"}
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

修改短信签名

输入示例

POST / HTTP/1.1
Host: sms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifySmsSign
<公共请求参数>

{
    "Remark": "测试使用",
    "SignType": "0",
    "CommissionImage": "base64",
    "SignName": "腾讯云",
    "DocumentType": "1",
    "International": "0",
    "SignId": "1110",
    "ProofImage": "base64",
    "UsedMethod": "1"
}

输出示例

{
    "Response": {
        "ModifySignStatus": {
            "SignId": 1110,
            "SignApplyId": "1109"
        },
        "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.MissingSignatureList 无法识别签名，请确认是否已有签名通过申请，一般是签名未通过申请，可以查看 签名审核。
FailedOperation.MissingSignatureToModify 此签名 ID 未提交申请或不存在，不能进行修改操作，请检查您的 SignId 是否填写正确。
FailedOperation.NotEnterpriseCertification 非企业认证无法使用签名及模板相关接口，您可以 变更实名认证模式，变更为企业认证用户后，约1小时左右生效。
FailedOperation.OtherError 其他错误，一般是由于参数携带不符合要求导致，请参考API接口说明，如有需要请联系 腾讯云短信小助手。
FailedOperation.TemplateAlreadyPassedCheck 此模板已经通过审核，无法再次进行修改。
FailedOperation.TemplateIdNotExist 模板 ID 不存在。
InternalError.OtherError 其他错误，请联系 腾讯云短信小助手 并提供失败手机号。
InternalError.ParseBackendResponseFail 解析运营商包体失败，可联系 sms helper 。
InternalError.RequestTimeException 请求发起时间不正常，通常是由于您的服务器时间与腾讯云服务器时间差异超过10分钟导致的，请核对服务器时间及 API 接口中的时间字段是否正常。
InternalError.RestApiInterfaceNotExist 不存在该 RESTAPI 接口，请核查 REST API 接口说明。
InternalError.SigVerificationFail 后端校验 Sig 失败。
InternalError.Timeout 请求下发短信超时，请参考 60008错误详解。
InternalError.UnknownError 未知错误类型。
InvalidParameter 参数错误。
InvalidParameter.AppidAndBizId 账号与应用id不匹配。
InvalidParameterValue.ImageInvalid 上传的转码图片格式错误，请参照 API 接口说明中对该字段的说明，如有需要请联系 腾讯云短信小助手。
InvalidParameterValue.InvalidDocumentType DocumentType 字段校验错误，请参照 API 接口说明中对该字段的说明，如有需要请联系 腾讯云短信小助手。
InvalidParameterValue.InvalidInternational International 字段校验错误，请参照 API 接口说明中对该字段的说明，如有需要请联系 腾讯云短信小助手。
InvalidParameterValue.InvalidUsedMethod UsedMethod 字段校验错误，请参照 API 接口说明中对该字段的说明，如有需要请联系 腾讯云短信小助手。
InvalidParameterValue.SignAlreadyPassedCheck 此签名已经通过审核，无法再次进行修改。
InvalidParameterValue.SignExistAndUnapproved 已存在相同的待审核签名。
InvalidParameterValue.SignNameLengthTooLong 签名内容长度过长。
UnauthorizedOperation.RequestIpNotInWhitelist 请求 IP 不在白名单中，您配置了校验请求来源 IP，但是检测到当前请求 IP 不在配置列表中，如有需要请联系 腾讯云短信小助手。
UnauthorizedOperation.RequestPermissionDeny 请求没有权限，请联系 腾讯云短信小助手。
UnauthorizedOperation.ServiceSuspendDueToArrears 欠费被停止服务，可自行登录腾讯云充值来缴清欠款。
UnsupportedOperation 操作不支持。
中国站
文档反馈
文档活动
message-icon联系我们
目录