You need to enable JavaScript to run this app.
导航

Conversion - 验码转化反馈

最近更新时间2024.01.29 14:41:45

首次发布时间2023.01.17 17:17:44

短信服务方使用方可调用Conversion将验码成功的MessageID反馈给短信服务。

请求说明

请求方式:POST
接口地址:https://sms.volcengineapi.com/?Action=Conversion&Version=2020-01-01

请求参数

Query

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

Conversion

要执行的操作,取值:Conversion

Version
String

2020-01-01

API的版本,取值:2020-01-01

Body

名称
类型
是否必填
示例值
描述
MessageIDs
Array of String

["b69aeb31-1e8b-48c9-ba5f-160b761a****","b34779e3-78a6-4ed9-9074-84a3f30b****"]

发送短信时返回的MessageID, 长度限制1-100

响应数据

名称
类型
示例值
描述
ResponseMetadata
ResponseMetadata

响应公共参数。

示例

成功请求示例

请求

{
    "MessageIDs": ["b69aeb31-1e8b-48c9-ba5f-160b761a****","b34779e3-78a6-4ed9-9074-84a3f30b****"]
}

响应

{
    "ResponseMetadata": {
        "RequestId": "021668604596455fdbddc0200ff00060a925dd300000730a3****",
        "Action": "Conversion",
        "Version": "2020-01-01",
        "Service": "volcSMS",
        "Region": "cn-north-1"
    },
    "Result": ""
}

错误码

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

HttpCode
错误码
错误信息
描述
200
RE:0000
账号鉴权失败

请检查参数是否使用正确或参考SDK内的鉴权处理

200
RE:0001
账号短信服务未开通

请检查当前AccessKey是否已经开通短信服务。如已开通短信服务,则参照短信服务文档调用接口。

200
RE:0007
IP校验错误

已开启IP白名单,请联系火山引擎客服确认当前IP是否已加白。

200
RE:0009
请求参数错误

请根据接口文档检查参数是否正确

200
RE:0500
未知交互类错误

请尝试重新调用接口