转至元数据结尾
转至元数据起始

正在查看旧版本。 查看 当前版本.

与当前比较 查看页面历史

« 上一页 版本 3 下一步 »

To create a recognition task using the createTask method and obtain the recognition result using the getTaskResult method.

This object is used for recognizing reCaptchaV2 versions.

Create Tasks

To create a recognition task using the createTask method.

Request node: INTERNATIONAL NODE https://api.yescaptcha.com CHINA NODE https://cn.yescaptcha.com

Method address:: https://api.yescaptcha.com/createTask

Request format:POST application/json

Example Structure

Parameters

Type

Required

Purpose

type

string

Yes

NoCaptchaTaskProxyless 15 POINTS DEFAULT

RecaptchaV2TaskProxyless 20 POINTS ->18 POINTS HIGHER QUALITY MORE STABLE

websiteURL

string

Yes

The address of the ReCaptcha web page.Fixed value.🔗 How to find the value of websiteURL?

websiteKey

String

Yes

The ReCaptcha website key. Fixed value.🔗 How to find the value of websiteKey?

isInvisible

Bool

No

If you encounter a reCaptchaV2 of isInvisible type, you need to add this parameter. 🔗 How to determine the version of reCaptcha?

Request Example

{
    "clientKey": "cc9c18d3e263515c2c072b36a7125eecc078618f",
    "task": {
        "websiteURL": "https://www.google.com/recaptcha/api2/demo",
        "websiteKey": "6Le-wvkSAAAAAPBMRTvw0Q4Muexq9bi0DJwx_mJ-",
        "type": "NoCaptchaTaskProxyless",
        "isInvisible": false // You only need to add the true value if the reCaptcha type is isInvisible.
    }
}

Response Example

{
    "errorId": 0,
    "errorCode": "",
    "errorDescription": "",
    "taskId": "61138bb6-19fb-11ec-a9c8-0242ac110006" // Please keep a record of this ID.
}

Get the Result

To obtain the recognition result using the getTaskResult method.

Request node: INTERNATIONAL NODE https://api.yescaptcha.com CHINA NODE https://cn.yescaptcha.com

Request address: https://api.yescaptcha.com/getTaskResult

Request format:POST application/json

Based on the system load, you will receive the result within a time interval of 10s to 80s, with a timeout of 120 seconds.

Request Example

{
    "clientKey":"cc9c18d3e263515c2c072b36a7125eecc078618f3",
    "taskId": "61138bb6-19fb-11ec-a9c8-0242ac110006"
}

Response Result

Parameters

Type

Purpose

errorId

Integer

Error message: 0 - No error, 1 - Error

errorCode

string

Error code.Check out🔗 errors list.

errorDescription

string

Error description

status

String

processing - task is not ready yet.
ready - task complete, solution object can be found in solution property.

solution

Object

Task result data. Different for each type of task.

gRecaptchaResponse

string

Recognition result: The response value, which is used to make a POST or simulated submission to the target website.

The response value is for one-time use only and is valid for 120 seconds. We recommend using it within 60 seconds.🔗 How to pass Google reCaptcha using the API

Response Example

{
    "errorId": 0,
    "errorCode": null,
    "errorDescription": null,
    "solution": {
        "gRecaptchaResponse": "03AGdBq25SxXT-pmSeBXjzScW-EiocHwwpwqtk1QXlJnGnU......"
    },
    "status": "ready"
}

Response Description

  • Recognition succeeded: If errorId = 0 and status is ready, the result is in the solution field.

  • Recognition in progress: If errorId = 0 and status is processing, please retry after 3 seconds.

  • Error occurred: If errorId > 0, please refer to errorDescription to learn more about the error message. 🔗 Error Types

FAQ:

 I would like to ask why sometimes the reCaptcha verification result I submit is successful, while other times it is not. What could be the reason for this?
  1. The result returned by the API may not be 100% successful in verification, and the success rate may vary depending on the website.

  2. The target website sets a score requirement, and those with a score lower than the requirement cannot pass the verification.

  3. The target website may adjust the score requirement at any time.

  4. If your website has some probability of passing, then it's already quite good.

  5. For V2, you can use image recognition API or paid plugins based on the image recognition API to achieve 100% success after clicking on the images.

  • 无标签