getTaskResult : request task result

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

  1. Request limit: 120 requests per task.

  2. After creating a task, you may query the task within the first 5 minutes.

 

Request parameters

Parameter

Type

Required

Purpose

Parameter

Type

Required

Purpose

clientKey

String

Yes

Unique key of your account.

taskId

string

Yes

ID which was obtained in createTask method.

 

Request example:

{ "clientKey":"cc9c18d3e263515c2c072b36a7125eecc078618f", "taskId": "f079dfc0-1877-11ec-a7e3-94e6f7355a0b" }

 

Response structure

Parameters

Type

Description

Parameters

Type

Description

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.

 

Response example

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