PRODUCT TEST WORKSPACE
Russian Captcha
Captcha verification product
RUSSIAN_CAPTCHA02 / REQUEST
Request preview
{
"productCode" : "RUSSIAN_CAPTCHA",
"adapter" : {
"body" : "BASE64_CONTENT"
}
}
03 / RESULT
Response example
—
{
"code" : 0,
"msg" : "Success",
"data" : {
"taskId" : "11111111-1111-4111-8111-111111111111",
"productCode" : "RUSSIAN_CAPTCHA",
"state" : "SUCCEEDED",
"solution" : {
"text" : "EXAMPLE_ANSWER"
}
}
}
Illustrative response; not a live task result. Replace all request placeholders before submitting.
Read data.solution after state becomes SUCCEEDED. The solution fields depend on the product; other states may return an empty object.
04 / API REFERENCE
Russian Captcha · API
For task creation and queries, send the API key in the apiKey HTTP header. JSON request bodies contain business parameters only.
Content-Type: application/json apiKey: YOUR_API_KEY
Request example
{
"productCode": "RUSSIAN_CAPTCHA", // Product code matching the adapter parameters.
"adapter": { // Product-specific parameter object.
"body": "BASE64_CONTENT", // Base64-encoded image or audio content.
"phrase": false, // Whether the answer contains multiple words.
"caseSensitive": false, // Whether the answer is case-sensitive.
"numeric": false, // Character recognition mode.
"math": false, // Whether to calculate the expression shown in the image.
"minLength": 1, // Minimum answer length.
"maxLength": 1, // Maximum answer length.
"comment": "YOUR_COMMENT", // Question or instructions for solving the challenge.
"imgInstructions": "YOUR_IMGINSTRUCTIONS" // Base64-encoded image instructions.
}
}
Request headers: apiKey: YOUR_API_KEY
Comments explain the fields. Copy produces valid JSON without comments.
Response example
{
"code": 0, // Business result code: 0 means success; other values indicate an error.
"msg": "Success", // Result message; may be empty on success.
"data": { // Response data; may be null on an error.
"taskId": "11111111-1111-4111-8111-111111111111", // Task ID returned by task creation.
"productCode": "RUSSIAN_CAPTCHA", // Product code matching the adapter parameters.
"state": "SUCCEEDED", // Task state: CREATED, SUBMITTING, PROCESSING, SUCCEEDED, FAILED or EXPIRED.
"solution": { // Product answer when SUCCEEDED; empty while processing or on failure.
"text": "EXAMPLE_ANSWER" // Recognized text or text answer.
}
}
}
Creating a task returns its ID and initial state. Query the result or use WebSocket to receive the completed answer shown below.
Request parameters
| Field | Type | Required | Description |
|---|---|---|---|
productCode | string | Yes | Product code matching the adapter parameters. |
adapter | object | Yes | Product-specific parameter object. |
adapter.body | string | Yes | Base64-encoded image or audio content. |
adapter.phrase | boolean | No | Whether the answer contains multiple words. |
adapter.caseSensitive | boolean | No | Whether the answer is case-sensitive. |
adapter.numeric | boolean | No | Character recognition mode. |
adapter.math | boolean | No | Whether to calculate the expression shown in the image. |
adapter.minLength | integer | No | Minimum answer length. |
adapter.maxLength | integer | No | Maximum answer length. |
adapter.comment | string | No | Question or instructions for solving the challenge. |
adapter.imgInstructions | string | No | Base64-encoded image instructions. |
Response parameters
| Field | Type | Description |
|---|---|---|
code | integer | Business result code: 0 means success; other values indicate an error. |
msg | string | Result message; may be empty on success. |
data | object | null | Response data; may be null on an error. |
data.taskId | string | Task ID returned by task creation. |
data.productCode | string | Product code matching the adapter parameters. |
data.state | string | Task state: CREATED, SUBMITTING, PROCESSING, SUCCEEDED, FAILED or EXPIRED. |
data.solution | object | Product answer when SUCCEEDED; empty while processing or on failure. |
data.failure | object | omitted | Public diagnosis for FAILED/EXPIRED only; no raw provider messages. Follow the failure handling guide. |
data.failure.code | string | Failure code |
data.failure.nextAction | string | Next action |
data.solution.text | string | Recognized text or text answer. |
Responses
HTTP business responses contain code, msg and data; code 0 means success. WebSocket uses a separate message structure.
- -1317
- Invalid API key.
- -1100 / -1101
- Invalid or missing request parameters.
- -1401
- Insufficient balance. Add funds before creating a task.
- -1400 / -1001
- System or task creation error.