短信验证码
发送并核验短信验证码。支持登录注册、改绑、重置密码、绑定、验证手机号等赠送模板。签名由本站统一配置。
POST JSON。发送:action=send,传入 mobile,可选 template。
核验:action=check,传入 mobile 和 code。
template 可用 100001–100005,或 login / change_mobile / reset_password / bind_mobile / verify_mobile。
核验:action=check,传入 mobile 和 code。
template 可用 100001–100005,或 login / change_mobile / reset_password / bind_mobile / verify_mobile。
调用地址:https://api.ynlskj.com.cn/gateway/smsverify
请求方法:POST
在其他地方怎么调用
- 请求地址用上面的调用地址,把 JSON 放在请求体里
- 方法用
POST - API Key 只能放在请求头
X-API-Key,不要写进网址,也不要写进 Query 框 - Key 在「个人中心 → API Key」里复制,登录后会自动填入你自己的 Key
参数说明
| 参数 | 位置 | 必填 | 说明 |
|---|---|---|---|
action | Body JSON | 否 | send 发送验证码(默认),check 核验验证码。只传 mobile+code 时按核验处理 |
mobile | Body JSON | 是 | 11 位手机号。也可用 phone |
template | Body JSON | 发送时否 | 默认 login。可用 100001–100005,或 login / change_mobile / reset_password / bind_mobile / verify_mobile |
min | Body JSON | 否 | 短信里展示的有效分钟数,默认 5,范围 1–30 |
code | Body JSON | 核验时是 | 用户收到的验证码。也可用 verify_code |
X-API-Key | Header | 是 | 你的 API Key |
请求示例
| 场景 | Body 示例 |
|---|---|
| 登录/注册发送 | {"action":"send","mobile":"13800138000","template":"login"} |
| 重置密码发送 | {"action":"send","mobile":"13800138000","template":"reset_password"} |
| 核验验证码 | {"action":"check","mobile":"13800138000","code":"123456"} |
赠送模板
| template | CODE | 用途 |
|---|---|---|
login | 100001 | 登录/注册 |
change_mobile | 100002 | 修改绑定手机号 |
reset_password | 100003 | 重置密码 |
bind_mobile | 100004 | 绑定新手机号 |
verify_mobile | 100005 | 验证绑定手机号 |
验证码由阿里云生成并保存,默认不回传明文。用户输入后再调 action=check 核验。data.pass=true 表示通过。
返回说明
| 字段 | 说明 |
|---|---|
ret | ok 成功,err 失败 |
code | 200 表示本次调用成功(核验是否通过看 data.pass) |
data.action | send 或 check |
data.biz_id | 发送成功时的阿里云业务 ID |
data.mobile | 脱敏后的手机号 |
data.template / template_name | 实际使用的模板 CODE 与名称 |
data.pass | 核验时有效。true 表示验证码正确 |
data.verify_result | PASS 通过 / UNKNOWN 失败 |
msg | 本站提示,如「次数充足,剩余 99 次」或「次数不足,剩余 0 次」 |
remain_quota | 本次调用后的剩余次数 |
可直接复制的代码
未登录时示例只显示「你的密钥」。登录后会自动填入你自己的 Key,不会展示别人的。
<?php
$ch = curl_init('https://api.ynlskj.com.cn/gateway/smsverify');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => ['X-API-Key: 你的密钥', 'Content-Type: application/json'],
CURLOPT_POSTFIELDS => '{
"action": "send",
"mobile": "13800138000",
"template": "login"
}',
]);
echo curl_exec($ch);
请求参数演示
{"action":"send","mobile":"13800138000","template":"login"}
响应演示
{"ret":"ok","code":200,"success":true,"errmsg":"发送成功","data":{"action":"send","biz_id":"112231421412414124123^4","mobile":"138****8000","template":"100001","template_name":"登录/注册","min":5}}