最近更新时间: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。您可以登录密钥管理页面获取。 |
ServiceName | string | 是 | volcSMS | 服务名称。短信服务的服务名称为volcSMS 。 |
Region | string | 是 | cn-north-1 | 区域名称。短信服务的区域名称为cn-north-1 。 |
Content-Type | string | 是 | application/json;charset=utf-8 | 指定请求消息体的结构化格式。短信服务的 Content-Type 为 |
参数 | 数据类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | string | 是 | ApplySmsSignature | 接口名称。该接口固定值为ApplySmsSignature 。 |
Version | string | 是 | 2021-01-11 | 接口版本。短信服务接口版本为2021-01-11 。 |
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
subAccount | string | 是 | A123**** | 消息组ID |
source | string | 是 | APP全称/简称 | 签名类型。可为:
|
domain | string | 是 | 工信部备案网站全称/简称 | |
content | string | 是 | 抖音 | 签名内容 |
desc | string | 是 | 用于发送注册验证码 | 申请说明 |
purpose | int32 | 是 | 1 | 签名用途; 1. 自用,2. 他用 |
uploadFileList | []SignAuthFile | 是 | [{"fileContent":"base64","fileSuffix": "jpg","fileType": 0}] | 签名资质证明文件 |
请求响应数据以JSON格式返回,以下仅列出了短信业务逻辑相关的字段,其他公共返回参数详见返回结果。
参数 | 数据类型 | 描述 |
---|---|---|
ResponseMetadata | ResponseMetadata | 响应公共参数。包含的参数说明请参见ResponseMetadata。 |
Result | Result | 响应业务参数。包含的参数说明请参见Result。 |
参数 | 数据类型 | 描述 |
---|---|---|
RequestId | string | 请求 ID。 |
Action | string | 请求的接口名称。 |
Version | string | 请求的版本号。 |
Service | string | 请求的服务名称。 |
Region | string | 请求的区域。 |
Error | Error | 错误信息。如果请求没有异常则不会返回错误信息。包含的参数说明请参见Error。 |
参数 | 数据类型 | 描述 |
---|---|---|
applyId | string | 申请的签名工单ID |
signature | string | 签名内容 |
application | string | 签名用途 |
source | string | 签名类型
|
status | int | 审核状态,1: 审核中,2: 未通过,3: 已开通,4: 已关闭,5: 免审 |
createdTime | int64 | 创建时间 |
reason | string | 原因。审核失败时返回。 |
参数 | 数据类型 | 描述 |
---|---|---|
Code | string | 错误码。 |
Message | string | 错误信息。 |
{ "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" } } }
如果您在返回结果中遇到错误消息,可以使用下表作为详细信息和解决方案的指南。其中火山引擎网关公共错误码请参考火山引擎网关公共错误码。
Code | Message | 说明 | 处理建议 |
---|---|---|---|
1001 | invalid_subAccount | 参数错误 | |
1003 | already existed | 申请签名时,签名已经存在或者正在审核 | |
1999 | 错误描述 | 系统错误 |