文档中心

CheckSmsVerifyCode - 校验验证码

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

首次发布时间：2023.01.17 17:17:38

短信服务使用方可以CheckSmsVerifyCode接口，校验用户填入的验证码是否有效。

请求说明

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

API Explorer

您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

Query

名称	类型	是否必填	示例值	描述
Action	String	是	CheckSmsVerifyCode	要执行的操作，取值：CheckSmsVerifyCode
Version	String	是	2020-01-01	API的版本，取值：2020-01-01

Body

名称	类型	是否必填	示例值	描述
SmsAccount	String	是	049c****	消息组ID（验码主键之一）
PhoneNumber	String	是	188********	接收手机号，不支持批量发送（验码主键之一）如果您设置的是中国大陆手机号，则国际区号为可选项。例如+86188和188都是合法的手机号码。如果您设置的是非中国大陆手机号，则国际区号为必填项，且格式需符合 E.164 标准。
Scene	String	是	注册验证码	验证码使用场景（验码主键之一）
Code	String	是	123456	待校验验证码

响应数据

名称	类型	示例值	描述
ResponseMetadata	ResponseMetadata		响应公共参数
Result	String		验码结果 0：成功； 1：错误； 2：过期；验码结果与传入重试次数有关，在有效期内时，重试次数为0的时候，验码失败就返回过期，重试次数不为0的时候，验码失败先返回错误，当累计错误次数超过阈值，返回过期

示例

成功请求示例

请求

{
    "SmsAccount": "A123****",
    "PhoneNumber": "152********",
    "Scene": "注册验证码",
    "code": "591005"
}

响应

{
    "ResponseMetadata": {
        "RequestId": "2022120918184901015013208125FC****",
        "Action": "CheckSmsVerifyCode",
        "Version": "2020-01-01",
        "Service": "volcSMS",
        "Region": "cn-north-1"
    },
    "Result": "0"
}

错误码

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

HttpCode	错误码	错误信息	描述
200	RE:0000	账号鉴权失败	请检查参数是否使用正确或参考SDK内的鉴权处理
200	RE:0001	账号短信服务未开通	请检查当前AccessKey是否已经开通短信服务。如已开通短信服务，则参照短信服务文档调用接口。
200	RE:0002	账号被关停	请联系火山引擎客服确认
200	RE:0003	子账号不存在	请填写正确的SmsAccount，即消息组ID
200	RE:0006	手机号格式错误	手机号参数请传入正确的格式。国内消息：+86或无任何前缀的11位手机号码，例如1580799**** 国际/港澳台消息：国际区号为必填项，且格式需符合 E.164 标准。
200	RE:0007	IP校验错误	已开启IP白名单，请联系火山引擎客服确认当前IP是否已加白。
200	RE:0009	请求参数错误	请根据接口文档检查参数是否正确
200	RE:0500	未知交互类错误	请尝试重新调用接口