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

回填验码率Conversion

最近更新时间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。您可以登录密钥管理页面获取。

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

Content-Type

string

application/json;charset=utf-8

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

Body

参数类型是否必填示例值说明

MessageIDs

[]string

["b69aeb31-1e8b-48c9-ba5f-160b761a2eb0","b34779e3-78a6-4ed9-9074-84a3f30b4fc0"]

HTTP发送短信返回的messageID,长度限制1-100; SMPP占位支持

返回结果

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

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

ResponseMetadata

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

Result

参数数据类型描述
Resultstring响应业务参数,没有错误时返回

Error

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

示例

请求示例

{
    "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"
        }
    }
}

错误码

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

CodeMessage说明处理建议
ZJ10200Param error. Please check that the parameters are correct.参数解析错误,检查传递参数是否正确。检查传递参数是否正确。
ZJ10200The length of MessageIDs should between 1 and 100回填消息个数必须是在1到100之间检查回填message_id的个数是否在1-100之间