# 查询建码任务进度

查询批量建码任务的整体 status、progress 和 total，按 poll_after_seconds 轮询。succeeded 只表示任务结束，逐项结果用 qrcodeTasks/getResults 核对。

## 请求

```text
POST https://open.cli.im/api/v2/rpc/qrcodeTasks/get
```

| 项目 | 要求 |
|---|---|
| 最低权限 | 读写，见[权限档位](https://cli.im/open-api/openapi/v2/auth.md#org-policy) |
| 需要的 scope | `qrcodes.write` |
| 组织 Key | 不能调用，返回 403 `credential_type_not_allowed`，见[历史组织 Key](https://cli.im/open-api/openapi/v2/auth.md#org-key) |

相关调用流程：[按模板批量建码](https://cli.im/open-api/openapi/v2/scenarios/batch-create-qrcodes.md)。

## 请求参数

请求体为 JSON。

| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| `task_id` | string | 是 | 任务 ID，取自 qrcodes/createBatch 或 gallery/create-from-plan 的返回。最长 128 个字符 |

## 请求示例

示例里的 ID、幂等键等换成实际值。

```bash
curl -sS -X POST 'https://open.cli.im/api/v2/rpc/qrcodeTasks/get' \
  -H "Authorization: Bearer ${CAOLIAO_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "task_id": "9031877"
}'
```

## 响应

成功时 HTTP 状态码为 200，顶层 `code` 为 `0`，结果在 `data` 里。失败时的返回见[错误码与调用额度](https://cli.im/open-api/openapi/v2/error-codes.md)和[业务错误码](https://cli.im/open-api/openapi/v2/error-catalog.md)。

| 字段 | 类型 | 一定返回 | 说明 |
|---|---|---|---|
| `data.task_id` | string | 是 | 任务 ID，用于 qrcodeTasks/get 和 qrcodeTasks/getResults |
| `data.batch_id` | string | 是 | 批次 ID |
| `data.template_id` | string | 是 | 模板 ID |
| `data.total` | integer | 是 | 本批提交的条数 |
| `data.receipt_expires_at` | integer | 是 | 任务回执的过期时间（Unix 秒），过期后不能再查询逐项结果 |
| `data.status` | string | 是 | 任务状态：queued 排队中；running 处理中；succeeded 已结束；failed 失败；cancelled 已取消。succeeded 只表示任务结束，每一项是否建好以 qrcodeTasks/getResults 为准。可选值：`queued`、`running`、`succeeded`、`failed`、`cancelled` |
| `data.progress` | integer | 是 | 进度百分比，0 到 100 |
| `data.processed_count` | integer | 是 | 已处理的条数；取不到时为 null |
| `data.created_at` | any | 是 | 任务创建时间；取不到时为 null |
| `data.updated_at` | any | 是 | 任务最近更新时间；取不到时为 null |
| `data.completion_scope` | string | 是 | 固定为 batch_task，表示 status 描述的是整批任务，不是每一项 |
| `data.poll_after_seconds` | integer | 是 | 建议的轮询间隔（秒） |
| `data.errors` | object[] | 否 | 未成功或未确认的部分；全部成功时为空数组 |
| `data.errors[].code` | string | 是 | 错误码，含义见规范顶层的 x-error-catalog |
| `data.errors[].path` | string | 否 | 出错字段在请求体中的位置，如 items.0.values.12345；没有具体位置时为空字符串 |
| `data.errors[].item_key` | string | 否 | 批量数据中出错那一项的 item_key；不针对某一项时为空字符串 |
| `data.errors[].retryable` | boolean | 否 | 原样重试是否可能成功 |
| `data.errors[].next_action` | string | 否 | 建议的下一步：correct_input 修正入参；retry_later 稍后重试；retry_same_idempotency_key 用原幂等键重试；inspect_created_qrcode、inspect_created_form、inspect_result 先读取已保存的内容核对 |
| `data.errors[].message` | string | 否 | 补充说明，部分错误才有 |

### 响应示例

```json
{
  "code": 0,
  "message": "ok",
  "data": {
    "task_id": "9031877",
    "batch_id": "b_20261118_7f3a",
    "template_id": "6801234",
    "total": 2,
    "receipt_expires_at": 1795000000,
    "status": "succeeded",
    "progress": 100,
    "processed_count": 2,
    "created_at": "2026-11-18 10:00:00",
    "updated_at": "2026-11-18 10:00:03",
    "completion_scope": "batch_task",
    "poll_after_seconds": 3
  }
}
```

## 常见错误

`TASK_NOT_FOUND`、`TASK_RECEIPT_EXPIRED`、`TASK_SERVICE_UNAVAILABLE`。含义和处理方式见[业务错误码](https://cli.im/open-api/openapi/v2/error-catalog.md)。

---

本页由 [openapi.json](https://cli.im/open-api/openapi/v2/overview.md#%E6%8E%A5%E5%8F%A3%E8%A7%84%E8%8C%83-openapi-json) 生成。全部接口见[接口清单](https://cli.im/open-api/openapi/v2/api-index.md)。
