PRODUCT TEST WORKSPACE
Alibaba Captcha
Captcha verification product
ALIBABA02 / REQUEST
Request preview
{
"productCode" : "ALIBABA",
"adapter" : {
"websiteURL" : "https://example.com/register",
"sceneId" : "YOUR_SCENEID",
"prefix" : "YOUR_PREFIX"
}
}
03 / RESULT
Response example
—
{
"code" : 0,
"msg" : "Success",
"data" : {
"taskId" : "11111111-1111-4111-8111-111111111111",
"productCode" : "ALIBABA",
"state" : "SUCCEEDED",
"solution" : {
"data" : {
"tokens" : "{\"sceneId\":\"EXAMPLE_SCENE_ID\",\"certifyId\":\"EXAMPLE_CERTIFY_ID\",\"deviceToken\":\"EXAMPLE_DEVICE_TOKEN\",\"data\":\"EXAMPLE_DATA\"}"
}
}
}
}
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
Alibaba 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": "ALIBABA", // Product code matching the adapter parameters.
"adapter": { // Product-specific parameter object.
"websiteURL": "https://example.com/register", // Full URL of the page containing the challenge.
"sceneId": "YOUR_SCENEID", // Alibaba scene identifier.
"prefix": "YOUR_PREFIX", // Alibaba challenge prefix.
"userId": "YOUR_USERID", // User identifier supplied by the target integration.
"userUserId": "YOUR_USERUSERID", // User identifier supplied by the target integration.
"verifyType": "YOUR_VERIFYTYPE", // Target verification mode.
"region": "YOUR_REGION", // Target verification region.
"userCertifyId": "YOUR_USERCERTIFYID", // Target verification identifier.
"apiGetLib": "YOUR_APIGETLIB", // Target API library URL.
"userAgent": "YOUR_BROWSER_USER_AGENT" // User-Agent of the browser that obtained the challenge.
}
}
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": "ALIBABA", // 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.
"data": { // Product-specific answer field; use it according to the target website verification protocol.
"tokens": "{\"sceneId\":\"EXAMPLE_SCENE_ID\",\"certifyId\":\"EXAMPLE_CERTIFY_ID\",\"deviceToken\":\"EXAMPLE_DEVICE_TOKEN\",\"data\":\"EXAMPLE_DATA\"}" // Verification token to submit to the target website.
}
}
}
}
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.websiteURL | string | Yes | Full URL of the page containing the challenge. |
adapter.sceneId | string | Yes | Alibaba scene identifier. |
adapter.prefix | string | Yes | Alibaba challenge prefix. |
adapter.userId | string | No | User identifier supplied by the target integration. |
adapter.userUserId | string | No | User identifier supplied by the target integration. |
adapter.verifyType | string | No | Target verification mode. |
adapter.region | string | No | Target verification region. |
adapter.userCertifyId | string | No | Target verification identifier. |
adapter.apiGetLib | string | No | Target API library URL. |
adapter.userAgent | string | No | User-Agent of the browser that obtained the challenge. |
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.data | object | Product-specific answer field; use it according to the target website verification protocol. |
data.solution.data.tokens | string | Verification token to submit to the target website. |
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.