OkayAPI Docs


API Path: /api/App/Captcha/Verify

API Description: 对用户输入的验证码进行核对,最多只能校验一次,失败后需要刷新验证码并重新验证

1
API Traffic
HTTP/HTTPS
Protocol
GET/POST
Method
UTF-8
Charset
JSON
Response

API Debug   


API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
captcha_idStringRequiredMIN: 6验证码唯一ID,通过App.Captcha.Create接口返回
captcha_codeStringRequiredMIN: 2;MAX: 10待校验的验证码

API Debug

KEYREQUIREDVALUE
app_key *Required
captcha_id *Required
captcha_code *Required

API Response

KEYTypeDescription
err_codeInt操作码,0表示验证通过,1表示验证码已过期,或不存在,2表示验证码错误,需要刷新重试
err_msgString错误提示信息,err_code非0时参考此提示信息

HTTP Response Code

HTTP Status CodeDescription
Http Status = 200Success
Http Status = 400Illegal-Params
Http Status = 401Illegal-Token
Http Status = 402IP-Banned
Http Status = 404API-NOT-Exsits
Http Status = 406Illegal-APPKEY
Http Status = 407APPKEY-Expired-Out
Http Status = 408APPKEY-Busy
Http Status = 409Illegal-Sign
Http Status = 413API-Traffic-NOT-Enough
Http Status = 415API-LOCKED
Http Status = 500Internal-Server-Error