最近更新时间：2023.02.28 19:32:47
首次发布时间：2023.01.17 17:17:44
客户可将验码成功的MessageID回传至火山引擎，火山引擎根据回传数据计算验码率
请求方式：POST
接口地址：https://sms.volcengineapi.com/?Action=Conversion&Version=2020-01-01
| 参数 | 数据类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
AccessKey | string | 是 | AKLTNzEzY2**** | 发送请求的火山引擎账号的 Access Key ID。您可以登录密钥管理页面获取。 |
SecretKey | string | 是 | RGTLuSHvnYxn**** | 发送请求的火山引擎账号的 Secret Access Key。您可以登录密钥管理页面获取。 |
| ServiceName | string | 是 | volcSMS | 服务名称。短信服务的服务名称为volcSMS。 |
| Region | string | 是 | cn-north-1 | 区域名称。 |
Content-Type | string | 是 | application/json;charset=utf-8 | 指定请求消息体的结构化格式。短信服务的 Content-Type 为 |
| 参数 | 类型 | 是否必填 | 示例值 | 说明 |
|---|---|---|---|---|
MessageIDs | []string | 是 | ["b69aeb31-1e8b-48c9-ba5f-160b761a2eb0","b34779e3-78a6-4ed9-9074-84a3f30b4fc0"] | HTTP发送短信返回的messageID，长度限制1-100； SMPP占位支持 |
请求响应数据以JSON格式返回，以下仅列出了短信业务逻辑相关的字段，其他公共返回参数详见返回结果。
| 参数 | 数据类型 | 描述 |
|---|---|---|
| ResponseMetadata | ResponseMetadata | 响应公共参数。包含的参数说明请参见ResponseMetadata。 |
| Result | Result | 响应业务参数。包含的参数说明请参见Result。 |
| 参数 | 数据类型 | 描述 |
|---|---|---|
| RequestId | string | 请求 ID。 |
| Action | string | 请求的接口名称。 |
| Version | string | 请求的版本号。 |
| Service | string | 请求的服务名称。 |
| Region | string | 请求的区域。 |
| Error | Error | 错误信息。如果请求没有异常则不会返回错误信息。包含的参数说明请参见 Error。 |
| 参数 | 数据类型 | 描述 |
|---|---|---|
| Result | string | 响应业务参数，没有错误时返回 |
| 参数 | 数据类型 | 描述 |
|---|---|---|
| Code | string | 错误码。 |
| Message | string | 错误信息。 |
{ "MessageIDs":[ "b69aeb31-1e8b-48c9-ba5f-160b761a2eb0", "b34779e3-78a6-4ed9-9074-84a3f30b4fc0" ] }
{ "ResponseMetadata": { "RequestId": "021668604596455fdbddc0200ff00060a925dd300000730a34a8e", "Action": "SendSms", "Version": "2020-01-01", "Service": "volcSMS", "Region": "cn-north-1" }, "Result": "" }
{ "ResponseMetadata": { "RequestId": "021668604278414fdbddc0200ff00060a925dd300000730b15ce0", "Action": "SendSms", "Version": "2020-01-01", "Service": "volcSMS", "Region": "cn-north-1", "Error": { "Code": "ZJ10200", "Message": "The length of MessageIDs should between 1 and 100" } } }
如果您在返回结果中遇到错误消息，可以使用下表作为详细信息和解决方案的指南。其中火山引擎网关公共错误码请参考火山引擎网关公共错误码。
| Code | Message | 说明 | 处理建议 |
|---|---|---|---|
| ZJ10200 | Param error. Please check that the parameters are correct. | 参数解析错误，检查传递参数是否正确。 | 检查传递参数是否正确。 |
| ZJ10200 | The length of MessageIDs should between 1 and 100 | 回填消息个数必须是在1到100之间 | 检查回填message_id的个数是否在1-100之间 |