You need to enable JavaScript to run this app.
最新活动
产品
解决方案
定价
生态与合作
支持与服务
开发者
了解我们
导航

申请短信签名ApplySmsSignature

最近更新时间2023.08.22 16:57:25

首次发布时间2023.01.13 21:04:56

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

接口说明

  • 请求方式:POST

  • 接口地址:https://sms.volcengineapi.com/?Action=ApplySmsSignature&Version=2021-01-11&area=cn

请求参数

参数数据类型是否必填示例值描述

AccessKey

string

AKLTNzEzY2****

发送请求的火山引擎账号的 Access Key ID。您可以登录密钥管理页面获取。

SecretKey

string

RGTLuSHvnYxn****

发送请求的火山引擎账号的 Secret Access Key。您可以登录密钥管理页面获取。

ServiceNamestringvolcSMS服务名称。短信服务的服务名称为volcSMS
Regionstringcn-north-1区域名称。短信服务的区域名称为cn-north-1

Content-Type

string

application/json;charset=utf-8

指定请求消息体的结构化格式。短信服务的 Content-Type 为application/json;charset=utf-8

Query

参数数据类型是否必填示例值描述
ActionstringApplySmsSignature接口名称。该接口固定值为ApplySmsSignature
Versionstring2021-01-11接口版本。短信服务接口版本为2021-01-11

Body

参数类型是否必填示例值描述
subAccountstringA123****消息组ID

source

string

APP全称/简称

签名类型。可为:

  • 公司全称/简称;

  • 工信部备案网站全称/简称;

  • APP全称/简称;

  • 公众号、小程序全称/简称;

  • 商标全称/简称;

  • 电商平台店铺名的全称/简称;

domainstring工信部备案网站全称/简称
contentstring抖音签名内容
descstring用于发送注册验证码申请说明
purposeint321签名用途; 1. 自用,2. 他用

uploadFileList

[]SignAuthFile

[{"fileContent":"base64","fileSuffix": "jpg","fileType": 0}]

签名资质证明文件
必须下面文件其一:
企业营业执照、
组织机构代码证、
税务登记证、
社会信用代码证书、
三证合一
如有补充可传更多

返回参数

请求响应数据以JSON格式返回,以下仅列出了短信业务逻辑相关的字段,其他公共返回参数详见返回结果

参数数据类型描述
ResponseMetadataResponseMetadata响应公共参数。包含的参数说明请参见ResponseMetadata
ResultResult响应业务参数。包含的参数说明请参见Result

ResponseMetadata

参数数据类型描述
RequestIdstring请求 ID。
Actionstring请求的接口名称。
Versionstring请求的版本号。
Servicestring请求的服务名称。
Regionstring请求的区域。
ErrorError错误信息。如果请求没有异常则不会返回错误信息。包含的参数说明请参见Error

Result

参数数据类型描述
applyIdstring申请的签名工单ID
signaturestring签名内容
applicationstring签名用途

source

string

签名类型

  • 公司全称/简称;

  • 工信部备案网站全称/简称;

  • APP全称/简称;

  • 公众号、小程序全称/简称;

  • 商标全称/简称;

  • 电商平台店铺名的全称/简称;

statusint审核状态,1: 审核中,2: 未通过,3: 已开通,4: 已关闭,5: 免审
createdTimeint64创建时间
reasonstring原因。审核失败时返回。

Error

参数数据类型描述
Codestring错误码。
Messagestring错误信息。

示例

请求示例

{
    "subAccount":"A123****",
    "source":"APP全称/简称",
    "content":"抖音",
    "desc":"用于发送注册验证码"
}

返回示例

正确返回示例

{
    "ResponseMetadata":{
        "RequestId":"202211221049040101310571****",
        "Action":"ApplySmsSignature",
        "Version":"2021-01-11",
        "Service":"volcSMS",
        "Region":"cn-north-1"
    },
    "Result":{
        "signature":"抖音",
        "applyId":"438159",
        "application":"仅限公司内部使用",
        "status":1,
        "source":"APP全称/简称",
        "reason":"",
        "createdTime":1663039569,
    }
}

错误返回示例

{
    "ResponseMetadata":{
        "RequestId":"202211221049040101310571****",
        "Action":"ApplySmsSignature",
        "Version":"2021-01-11",
        "Service":"volcSMS",
        "Region":"cn-north-1",
        "Error":{
            "Code":"1003",
            "Message":"抖音 already existed"
        }
    }
}

错误码

如果您在返回结果中遇到错误消息,可以使用下表作为详细信息和解决方案的指南。其中火山引擎网关公共错误码请参考火山引擎网关公共错误码

CodeMessage说明处理建议
1001invalid_subAccount参数错误
1003already existed申请签名时,签名已经存在或者正在审核
1999错误描述系统错误