GeetestGobangWebTask

The gobang captcha is a common image challenge that asks the user to swap the positions of two balls on a 5×5 grid so that five identical balls line up in a row (horizontally, vertically, or diagonally).

1. Create a task

Request

POST https://api.omocaptcha.com/v2/createTask

Parameter	Type	Required	Description
`clientKey`	`String`	✅	Client account key
`task.type`	`String`	✅	Captcha service class name
`task.imageBase64`	`String`	✅	Base64-encoded 5×5 ball grid image

curl -X POST https://api.omocaptcha.com/v2/createTask \
  -H "Content-Type: application/json" \
  -d '{
    "clientKey": "OMO_API_KEY",
    "task": {
      "type": "GeetestGobangWebTask",
      "imageBase64": "BASE64_BODY_HERE"
    }
  }'

const res = await fetch("https://api.omocaptcha.com/v2/createTask", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    clientKey: "OMO_API_KEY",
    task: {
      type: "GeetestGobangWebTask",
      imageBase64: "BASE64_BODY_HERE"
    }
  })
});
console.log(await res.json());

import requests

res = requests.post("https://api.omocaptcha.com/v2/createTask", json={
    "clientKey": "OMO_API_KEY",
    "task": {
        "type": "GeetestGobangWebTask",
        "imageBase64": "BASE64_BODY_HERE"
    }
})
print(res.json())

<?php
$ch = curl_init("https://api.omocaptcha.com/v2/createTask");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Content-Type: application/json"]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
    "clientKey" => "OMO_API_KEY",
    "task" => [
        "type" => "GeetestGobangWebTask",
        "imageBase64" => "BASE64_BODY_HERE"
    ]
]));
echo curl_exec($ch);

Response

Success:

{
  "errorId": 0,
  "taskId": "49f9f60a-c809-4af0-93c0-0409b72e67e0"
}

The server returns errorId = 0 and a taskId when the task is created successfully. Failure:

{
  "errorId": 1,
  "errorCode": "",
  "errorDescription": ""
}

The server returns errorId = 1 along with the corresponding errorCode.

2. Get the task result

Request

POST https://api.omocaptcha.com/v2/getTaskResult

{
  "clientKey": "OMO_API_KEY",
  "taskId": "49f9f60a-c809-4af0-93c0-0409b72e67e0"
}

Response

Success:

{
  "errorId": 0,
  "errorCode": "",
  "errorDescription": "",
  "status": "ready",
  "solution": {
    "swap_positions": [2, 21]
  }
}

The server returns errorId = 0 and status = ready. Read the result from the solution field.

solution.swap_positions is a pair of cell indices to swap on the 5×5 grid. Cells are numbered from 0 to 24, left-to-right and top-to-bottom (top-left cell is 0, top-right cell is 4, first cell of row 2 is 5, …, bottom-right cell is 24). Drag the ball from the first cell onto the second cell (or vice versa) to solve the captcha.

Processing:

{
  "status": "processing",
  "errorId": 0,
  "errorCode": "",
  "errorDescription": ""
}

The server returns errorId = 0 and status = processing. Wait 2 seconds and poll again. Failure:

{
  "errorId": 1,
  "errorCode": "ERROR_JOB_STATUS",
  "errorDescription": "Job failed",
  "status": "fail",
  "solution": {}
}

The server returns errorId = 1 when the task fails.

API Reference

Guides

GeetestGobangWebTask

1. Create a task

Request

Response

2. Get the task result

Request

Response

​1. Create a task

​Request

​Response

​2. Get the task result

​Request

​Response

1. Create a task

Request

Response

2. Get the task result

Request

Response