You need to enable JavaScript to run this app.
导航
ApplySmsSignature - 申请短信签名
最近更新时间:2024.07.01 11:56:06首次发布时间:2023.01.13 21:04:56

短信服务方可用调ApplySmsSignature申请短信签名。

请求说明

  • 请求方式:POST
  • 接口地址:https://sms.volcengineapi.com/?Action=ApplySmsSignature&Version=2021-01-11

请求参数

Query

名称
类型
是否必填
示例值
描述
Action
String

ApplySmsSignature

要执行的操作,取值:ApplySmsSignature

Version
String

2021-01-11

API的版本,取值:2021-01-11

Body

名称
类型
是否必填
示例值
描述
subAccount
String

A123****

消息组ID

source
String

APP全称/简称

签名类型。可取值的:

  • 公司全称/简称;
  • 工信部备案网站全称/简称;
  • APP全称/简称;
  • 公众号、小程序全称/简称;
  • 商标全称/简称;
  • 电商平台店铺名的全称/简称;
content
String

短信签名

签名内容

desc
String

用于发送注册验证码

申请说明

domain
String

example.com

工信部备案网站

purpose
Integer

1

签名用途:

  • 1:自用;
  • 2:他用
signatureIdentificationID
Integer

12

实名资质id

响应数据

名称
类型
示例值
描述
ResponseMetadata
ResponseMetadata

响应公共参数。

Result
SignatureApplyResp

响应业务参数。

示例

成功请求示例

请求

{
  "subAccount": "79f4****",
  "purpose": 1,
  "source": "企业全称或简称",
  "content": "签名",
  "desc": "发送注册验证码",
  "domain": "example.com",
  "signatureIdentificationID": 12
}

响应

{
    "ResponseMetadata":{
        "RequestId":"202211221049040101310571****",
        "Action":"ApplySmsSignature",
        "Version":"2021-01-11",
        "Service":"volcSMS",
        "Region":"cn-north-1"
    },
    "Result":{
        "signature":"签名",
        "applyId":"4****9",
        "application":"仅限公司内部使用",
        "status":1,
        "Source":"企业全称或简称",
        "reason":"",
        "createdTime":1663039569,
    }
}

错误码

下表提供了该接口业务逻辑相关的错误码。公共错误码请参见公共错误码

HttpCode
错误码
错误信息
描述
200
1001
参数错误

参数错误

200
1003
already existed

申请签名时,签名已经存在或者正在审核

200
1999
系统错误

系统错误