错误代码和说明

hi-captcha

370字约1分钟

2024-05-21

API错误

此类错误通常发生在未正确调用API，余额不足等。

发生错误时的HTTP状态码为4xx，5xx，你可以使用各语言的http请求是否正常完成的判断方法来检测错误

返回的信息如下

{
  "statusCode":401,
  "message":"Authorization 错误",
  "error":"Unauthorized"
}

请将message返回给用户或是打印到日志中便于排查错误

以下是Python语言处理这类错误的示例代码

import requests

headers = {
    'Authorization': 'Bearer 你的token',
}

response = requests.get('https://api.hi-captcha.com/captcha/users/self', headers=headers)
if response.ok:
    print("请求成功")
else:
    print("发生错误")
print(response.json())

验证码识别错误

🔗获取任务结果: /captcha/tasks/{taskId}

此类错误通常出现在获取任务结果时，错误代码如下：

// TODO: 待完善

errorCode	errorDescription	说明
ERROR_SERVICE_UNAVALIABLE	服务暂时不可用	可能是服务器压力较大，请稍后再试，如果持续出现请联系客服

错误示例如下

{
  "id": "xxxx",
  "account": "xxxxx",
  "price": "0.012",   //价格
  "deducted": false,  //是否扣费
  "captchaType": "ReCaptchaV2",
  "request": {  // 提交的任务信息
    "isInvisible": false,
    "useCache": true,
    "captchaType": "ReCaptchaV2",
    "siteKey": "xxxxx",
    "siteReferer": "xxxxx"
  },
  "reason": "ERROR_RECAPTCHA_INVALID_DOMAIN",  // 错误代码
  "status": "Fail", // 状态
  "finished": "2023-07-27T08:29:49.565Z",
  "created": "2023-07-27T08:29:47.274Z",
  "ip": "xxxx",
  "fromCache": false
}