校验短信验证码

HTTP/HTTPS GET/POST UTF-8 JSON v1.0

接口地址:http://www.yesx2.com/api/admin.php?s=Admin.Sms.CheckSmsCaptcha  

接口描述: 接口发送短信验证码。验证码将在15分钟内有效,可尝试5次,成功校验的失败。使用前请修改./config/app.php配置文件中的aliYun配置。

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
mobile字符串必须-最小:11;最大:11国内手机号,11位
code字符串必须-最小:4;最大:64位到6位的数字验证码

返回字段

返回结果类型说明
ret整型状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误
data对象或混合类型业务数据,由各自接口指定,通常为对象
data.操作码,0成功,1验证码不存在或已过期,2验证码已失效(失败次数过多),3验证码错误code
data.msg字符串检验信息
msg字符串提示信息,失败时的错误提示

在线测试   


参数是否必须
service 必须
access_token 可选
mobile 必须
code 必须

客户端请求示例

# 暂无示例,可添加示例文件:./src/view/docs/demos/Admin.Sms.CheckSmsCaptcha.json

错误列表

错误状态码错误描述信息
400表示客户端参数错误
404表示接口服务不存在
500表示服务端内部错误

本文档生成时间:2024-03-29 09:06:29