短信验证

短信验证码能力:阿里云号码认证发送与核验,服务端生成/校验验证码,防短信轰炸。当前接入阿里云线路。

/api/sms_verify/

服务说明

短信验证服务基于阿里云号码认证能力,由服务端完成验证码的生成、下发与核验:先调发送接口向手机号下发验证码,用户输入后再调核验接口判断是否正确或已过期。

接入方可自定义验证码长度、有效时长、重复发送策略与频控间隔(默认 60 秒),用于防止短信被刷;核验在阿里云侧完成,调用方无需自己存储和比对验证码。

全部接口需项目签名,且请求体为 application/x-www-form-urlencoded 表单,不使用 JSON body。

响应格式

所有接口返回同一个 JSON 信封,业务数据都在 data 里:

{
  "code": 10000,
  "msg": "成功",
  "data": { ... }
}
  • code:业务状态码,10000 表示成功;其余为各类错误,完整清单见「错误码」页。
  • msg:给人看的提示文案,可直接展示给终端用户,但不要用它做逻辑判断。
  • data:业务数据;出错时通常为 null。各接口 data 的具体字段见该接口的「响应说明」。

判断成功与否请看 code,不要依赖 HTTP 状态码。 查看完整错误码

阿里云短信验证码

阿里云号码认证服务(Dypnsapi) 需签名

发送验证码由阿里云系统动态生成并完成核验;全部接口需接入项目签名,防短信被滥用。

POST /api/sms_verify/aliyun/send 累计调用 0 次

发送短信验证码

向指定手机号发送短信验证码;验证码有效期、频控间隔等可配。

11 位手机号(必填)

选填:4-8,默认 4

选填:验证码有效时长,默认 300 秒(5 分钟)

选填:默认 1(覆盖旧码)

选填:频控间隔,默认 60 秒(防短信轰炸)

选填:1-7(1=纯数字),默认 1

选填:仅测试场景建议开启 true,便于直接取码核验

选填:留空使用阿里云默认方案

选填:外部流水号(透传返回)

  • 请求体为 application/x-www-form-urlencoded 表单;本服务需项目签名(app_id/timestamp/nonce/sign)。
  • 发送成功即返回 code=10000;频控触发时提示等待(interval 秒)后再试。
响应说明 外层统一格式
字段 类型 说明
biz_id string 阿里云发送流水号
out_id string 外部流水号(透传返回)
verify_code string 验证码,仅开启返回时有值
返回示例
{"biz_id": "9006197469364984400", "out_id": "", "verify_code": ""}
POST /api/sms_verify/aliyun/check 累计调用 0 次

核验短信验证码

核验用户输入的验证码是否正确/是否过期。

11 位手机号(必填)

手机收到的验证码(必填)

选填:默认 1(不区分大小写)

选填:须与发送验证码时一致,留空使用默认方案

选填:外部流水号(透传返回)

  • 接口请求成功统一返回 code=10000;业务结果以 data.verify_result 判断:
  • PASS=核验成功,UNKNOWN=核验失败(验证码错误或已过期)。
响应说明 外层统一格式
字段 类型 说明
verify_result string 核验结果:PASS/UNKNOWN
passed bool 是否核验通过
out_id string 外部流水号(透传返回)
返回示例
{"verify_result": "PASS", "passed": true, "out_id": ""}
小影API · 通用 API 聚合服务