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

验证验证码

最近更新时间2023.04.20 19:37:35

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

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

接口说明

  • 请求方式:POST

  • 接口地址:https://sms.volcengineapi.com/?Action=CheckSmsVerifyCode&Version=2020-01-01

请求参数

参数数据类型是否必填示例值描述

AccessKey

string

AKLTNzEzY2****

发送请求的火山引擎账号的 Access Key ID。您可以登录密钥管理页面获取。

SecretKey

string

RGTLuSHvnYxn****

发送请求的火山引擎账号的 Secret Access Key。您可以登录密钥管理页面获取。

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

Content-Type

string

application/json;charset=utf-8

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

Query

参数数据类型是否必填示例值描述
ActionstringCheckSmsVerifyCode接口名称。该接口固定值为CheckSmsVerifyCode
Versionstring2021-01-01接口版本。短信服务接口版本为2020-01-01

Body

参数类型是否必填示例值描述
SmsAccountstring049c2666短信平台的帐号,验码主键之一
Scenestring注册验证码验证码使用场景,验码主键之一

PhoneNumber

string

188********

接收手机号,验码主键之一
- 如果您设置的是中国大陆手机号,则国际区号为可选项。例如+86188********和188********都是合法的手机号码。
- 如果您设置的是非中国大陆手机号,则国际区号为必填项,且格式需符合 E.164 标准。

Codestring123456待校验验证码

返回参数

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

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

ResponseMetadata

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

Result

参数数据类型描述

Result

string

验码结果

  • 0:成功;

  • 1:错误;

  • 2:过期;

验码结果与传入重试次数有关,在有效期内时,重试次数为0的时候,验码失败就返回过期,重试次数不为0的时候,验码失败先返回错误,当累计错误次数超过阈值,返回过期

Error

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

示例

请求示例

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

返回示例

正确返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022120918184901015013208125FCC564",
        "Action": "",
        "Version": "",
        "Service": "",
        "Region": ""
    },
    "Result": "2"
}

错误返回示例

{
    "ResponseMetadata": {
        "RequestId": "202212091819250101501341400AFDE5EE",
        "Action": "",
        "Version": "",
        "Service": "",
        "Region": "",
        "Error": {
            "Code": "ZJ10100",
            "Message": "Account is unusable. Please check whether SMS is enabled."
        }
    }
}

错误码

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

CodeMessage说明处理建议
ZJ10100Account not exist. Please check whether SMS is enabled账号不存在,一般为没有开通短信服务到火山引擎开通短信服务
ZJ10101SmsAccount not exist.SmsAccount 填写错误填写正确的 SmsAccount
ZJ10102Sign not exist.参数中指定的签名不存在使用审核通过的签名下发短信
ZJ10103TemplateID not exist.参数中指定的模板 ID 不存在使用审核通过的模板下发短信

ZJ10200

Param error. Please check that the parameters are correct.

请求参数错误

--

ZJ10203Mobile format error.传入的电话号码格式错误检查号码格式
ZJ10500System error系统错误联系短信业务平台管理员