验证码校验 API

使用该接口校验用户提交的验证码/一次性验证码 (OTP) 是否有效。阅读本文档前请先阅读 API 通用说明。

在使用发送验证码 API 将验证码发送给用户后，您可以简单地通过提交收到的验证码和用户手机号来快速验证其提供的验证码是否正确，无需缓存任何数据。

接口定义

接口名: otp.verify
HTTP Method: POST
Content-Type: application/json

请求参数

参数名	类型	必须	描述	示例值
to	string	是	用于验证的用户手机号，使用 E.164 格式	+8618658000123
code	string	是	用于验证的验证码，必须为 4-8 位数字串	123456
intent	string	否	用户验证的意图，应与发送验证码 API 传入的意图相同，最大长度 36 个字符	login
ttl	integer	否	验证码有效时间（秒），最大值: `1800`，默认为 `300` (5 分钟) * 仅适用于自动生成的验证码，不影响自定义验证码。	300

请求示例

以下示例将检查并返回用户提供的验证码是否正确。

curl -X POST 'https://api-cn.unimtx.com/?action=otp.verify&accessKeyId=YOUR_ACCESS_KEY_ID' \
-H 'Content-Type: application/json' \
-d '{
  "to": "+86186580001xx",
  "code": "123456"
}'

响应参数

参数名	类型	描述	示例值
code	string	返回码	0
message	string	返回信息	Success
data	JSON	返回结果

返回结果 `data`

参数名	类型	描述	示例值
to	string	用户手机号 (E.164)	+8618658000123
valid	boolean	提供的验证码是否有效	true

响应示例

成功响应示例

Status Code: 200, Response Body:

{
  "code": "0",
  "message": "Success",
  "data": {
    "to": "+8618658000123",
    "valid": true
  }
}

失败响应示例

Status Code: 400, Response Body:

{
  "code": "104001",
  "message": "MissingParams"
}