PRODUCT TEST WORKSPACE
Text Captcha
Captcha verification product
TEXT02 / REQUEST
请求预览
POST /api/validator/create.cgi
{
"productCode" : "TEXT",
"adapter" : {
"comment" : "YOUR_COMMENT"
}
}
03 / RESULT
响应示例
Task ID
—
{
"code" : 0,
"msg" : "操作成功",
"data" : {
"taskId" : "11111111-1111-4111-8111-111111111111",
"productCode" : "TEXT",
"state" : "SUCCEEDED",
"solution" : {
"text" : "EXAMPLE_ANSWER"
}
}
}
响应仅为示例，不是真实任务结果。提交前请替换请求中的所有示例值。
状态为 SUCCEEDED 后读取 data.solution。答案字段因产品而异，其他状态可能返回空对象。
04 / API REFERENCE
Text Captcha · API
创建和查询任务时，将 API Key 统一放在 HTTP apiKey 请求头中；JSON 请求体只包含业务参数。
Content-Type: application/json apiKey: YOUR_API_KEY
请求示例
{
"productCode": "TEXT", // 产品编码，必须与 adapter 参数匹配。
"adapter": { // 产品专属参数对象。
"comment": "YOUR_COMMENT" // 提交给人工识别者的说明。
}
}
请求头: apiKey: YOUR_API_KEY
注释用于说明字段，复制后得到不含注释的标准 JSON。
响应示例
{
"code": 0, // 业务返回码，0 表示成功，其他值表示错误。
"msg": "操作成功", // 结果说明，成功时可能为空。
"data": { // 响应数据，接口报错时可能为 null。
"taskId": "11111111-1111-4111-8111-111111111111", // 创建任务返回的任务 ID。
"productCode": "TEXT", // 产品编码，必须与 adapter 参数匹配。
"state": "SUCCEEDED", // 任务状态：CREATED、SUBMITTING、PROCESSING、SUCCEEDED、FAILED、EXPIRED。
"solution": { // SUCCEEDED 时的产品答案；处理中或失败时为空对象。
"text": "EXAMPLE_ANSWER" // 识别出的文字或文本答案。
}
}
}
创建任务返回任务 ID 和初始状态。下方为查询接口的完成结果，也可通过 WebSocket 接收答案。
请求参数说明
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
productCode | string | 是 | 产品编码，必须与 adapter 参数匹配。 |
adapter | object | 是 | 产品专属参数对象。 |
adapter.comment | string | 是 | 提交给人工识别者的说明。 |
响应参数说明
| 字段 | 类型 | 说明 |
|---|---|---|
code | integer | 业务返回码，0 表示成功，其他值表示错误。 |
msg | string | 结果说明，成功时可能为空。 |
data | object | null | 响应数据，接口报错时可能为 null。 |
data.taskId | string | 创建任务返回的任务 ID。 |
data.productCode | string | 产品编码，必须与 adapter 参数匹配。 |
data.state | string | 任务状态：CREATED、SUBMITTING、PROCESSING、SUCCEEDED、FAILED、EXPIRED。 |
data.solution | object | SUCCEEDED 时的产品答案；处理中或失败时为空对象。 |
data.failure | object | omitted | 仅 FAILED 或 EXPIRED 返回的公开诊断，不含上游原始消息；按失败处理指引操作。 |
data.failure.code | string | 失败编码 |
data.failure.nextAction | string | 下一步 |
data.solution.text | string | 识别出的文字或文本答案。 |
响应
HTTP 业务响应包含 code、msg 和 data；code 为 0 表示成功。WebSocket 使用独立的消息结构。
- -1317
- API Key 无效。
- -1100 / -1101
- 请求参数错误或缺失。
- -1401
- 余额不足，请充值后再创建任务
- -1400 / -1001
- 系统或创建任务错误。