核验短信验证码-追梦API

核验短信验证码

/api/v1/check 免费运行中

核验短信验证码,需要配合短信验证码，使用，此接口不扣费。

请求示例

request

CURL Python Node.js

curl -X POST https://api.zhuimengapi.com/api/v1/check \
  -H "X-API-Key: RPA-xxxxxxxx"
  -H "Content-Type: application/json"
  -d '{
    "phone_number": "接收验证码的手机号，必须与发送时的号码一致",
    "verify_code": "用户输入的验证码。注意：发送时用##code##占位符生成的验证码，发送时传固定值则无法校验，需自行比对",
    "scheme_name": "方案名称，最长20字符。重要：若发送时传了此字段，校验时必须与发送接口的方案名称一致",
    "country_code": "国家编码，默认86",
    "case_auth_policy": 0,
    "out_id": "外部流水号，透传"
}'

import requests

url = "https://api.zhuimengapi.com/api/v1/check"
headers = {"X-API-Key": "RPA-xxxxxxxx", "Content-Type": "application/json"}
data = {
    "phone_number": "接收验证码的手机号，必须与发送时的号码一致",
    "verify_code": "用户输入的验证码。注意：发送时用##code##占位符生成的验证码，发送时传固定值则无法校验，需自行比对",
    "scheme_name": "方案名称，最长20字符。重要：若发送时传了此字段，校验时必须与发送接口的方案名称一致",
    "country_code": "国家编码，默认86",
    "case_auth_policy": 0,
    "out_id": "外部流水号，透传"
}

res = requests.post(url, json=data, headers=headers)
print(res.json())

const axios = require('axios');

axios.post("https://api.zhuimengapi.com/api/v1/check", {
    "phone_number": "接收验证码的手机号，必须与发送时的号码一致",
    "verify_code": "用户输入的验证码。注意：发送时用##code##占位符生成的验证码，发送时传固定值则无法校验，需自行比对",
    "scheme_name": "方案名称，最长20字符。重要：若发送时传了此字段，校验时必须与发送接口的方案名称一致",
    "country_code": "国家编码，默认86",
    "case_auth_policy": 0,
    "out_id": "外部流水号，透传"
}, {
  headers: { "X-API-Key": "RPA-xxxxxxxx", "Content-Type": "application/json" }
}).then(res => console.log(res.data));

响应示例

response.json

{
    "Code": "接口请求状态码。返回OK代表请求成功，其他错误码请参见返回码。重要：接口请求成功不代表短信验证码核验成功，短信验证码核验结果仅以Model.VerifyResult参数返回值为准",
    "Message": "状态码的描述",
    "Success": false,
    "RequestId": "请求ID",
    "AccessDeniedDetail": "访问被拒绝详细信息",
    "Model": {
        "VerifyResult": "短信验证码核验结果。PASS：短信验证码核验成功，UNKNOWN：短信验证码核验失败",
        "OutId": "外部流水号"
    }
}

接口信息

请求地址 https://api.zhuimengapi.com/api/v1/check

请求方式 POST

Content-Type application/json

鉴权方式 X-API-Key: RPA-xxxxxxxx

请求参数

phone_number string 必填

接收验证码的手机号，必须与发送时的号码一致

verify_code string 必填

用户输入的验证码。注意：发送时用##code##占位符生成的验证码，发送时传固定值则无法校验，需自行比对

scheme_name string

方案名称，最长20字符。重要：若发送时传了此字段，校验时必须与发送接口的方案名称一致

country_code string

国家编码，默认86

case_auth_policy int

大小写字母核验策略：1=不区分大小写，2=区分大小写

out_id string

外部流水号，透传

返回字段

Code string 必填

接口请求状态码。返回OK代表请求成功，其他错误码请参见返回码。重要：接口请求成功不代表短信验证码核验成功，短信验证码核验结果仅以Model.VerifyResult参数返回值为准

Message string 必填

状态码的描述

Success boolean 必填

接口调用是否成功。true：接口调用成功，false：接口调用失败。重要：接口调用成功不代表短信验证码核验成功，短信验证码核验结果仅以Model.VerifyResult参数返回值为准

RequestId string 必填

请求ID

AccessDeniedDetail string

访问被拒绝详细信息

Model object

请求结果数据

VerifyResult string

短信验证码核验结果。PASS：短信验证码核验成功，UNKNOWN：短信验证码核验失败

OutId string

外部流水号

200请求成功
401API Key 无效或已过期，请检查密钥是否正确
402余额不足，请充值后再试
403IP 地址不在允许范围内或被限制访问
404接口路由不存在，请检查接口地址
429请求频率超限，请稍后再试
500服务器内部错误，请联系技术支持
502接口异常，或者传参错误，请联系技术支持

请求地址 https://api.zhuimengapi.com/api/v1/check

请求方式 POST

Content-Type application/json

鉴权 Header X-API-Key

API Key

Params Body

Params GET 请求只通过 URL 查询参数发送

Body JSON 模式 POST + application/json 使用原始 JSON 请求体

request body (JSON)

{
    "phone_number": "接收验证码的手机号，必须与发送时的号码一致",
    "verify_code": "用户输入的验证码。注意：发送时用##code##占位符生成的验证码，发送时传固定值则无法校验，需自行比对",
    "scheme_name": "方案名称，最长20字符。重要：若发送时传了此字段，校验时必须与发送接口的方案名称一致",
    "country_code": "国家编码，默认86",
    "case_auth_policy": 0,
    "out_id": "外部流水号，透传"
}

快速信息

接口路由	`check`
接口分类	-
请求方式	POST
计费方式	免费
频率限制	不限制
认证方式	`X-API-Key`
接口提供	官方接口

如何调用

注册/登录本站账号
前往用户中心 → API密钥，创建一个密钥
在请求头添加 X-API-Key 携带密钥即可调用
每次成功调用将扣除 0 积分

前往创建 API 密钥