分页读取批量建码逐项结果
按输入顺序分页返回批量建码每一项的结果:item_key 对应的码 ID、coding、web_url 和实际字段值。content_pending 的项需继续查询;回执 24 小时后过期。
请求
text
POST https://open.cli.im/api/v2/rpc/qrcodeTasks/getResults| 项目 | 要求 |
|---|---|
| 最低权限 | 读写,见权限档位 |
| 需要的 scope | qrcodes.write |
| 组织 Key | 不能调用,返回 403 credential_type_not_allowed,见历史组织 Key |
相关调用流程:按模板批量建码。
请求参数
请求体为 JSON。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
task_id | string | 是 | 任务 ID,取自 qrcodes/createBatch 或 gallery/create-from-plan 的返回。最长 128 个字符 |
page | integer | 否 | 页码,从 1 开始。默认 1。最小 1 |
page_size | integer | 否 | 每页条数。默认 20。范围 1–100 |
请求示例
示例里的 ID、幂等键等换成实际值。
bash
curl -sS -X POST 'https://open.cli.im/api/v2/rpc/qrcodeTasks/getResults' \
-H "Authorization: Bearer ${CAOLIAO_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
"task_id": "9031877",
"page": 1,
"page_size": 20
}'响应
成功时 HTTP 状态码为 200,顶层 code 为 0,结果在 data 里。失败时的返回见错误码与调用额度和业务错误码。
| 字段 | 类型 | 一定返回 | 说明 |
|---|---|---|---|
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 | 否 | 补充说明,部分错误才有 |
data.items | object[] | 是 | 本页各项的结果,顺序与提交时一致 |
data.items[].item_key | string | 是 | 提交时的 item_key |
data.items[].qrcode_id | string | 是 | 建好的码 ID;尚未建好或无法确认时为 null |
data.items[].coding | string | 是 | 码的短编号,用于按编号查询内容(如 qrcodes/getContent 的 qrcode 参数) |
data.items[].web_url | string | 是 | 码的扫码地址,即二维码里编码的网址 |
data.items[].name | string | 是 | 码名称 |
data.items[].status | string | 是 | pending 处理中;succeeded 已建好且内容已核对;content_pending 码已建好,内容仍在保存,需继续查询;unknown 无法确认结果;unavailable 码已被删除、移动或无权读取。可选值:pending、succeeded、content_pending、unknown、unavailable |
data.items[].error | object | 是 | status 不是 succeeded 或 pending 时的原因 |
data.items[].error.code | string | 是 | 错误码 |
data.items[].error.message | string | 是 | 说明 |
data.items[].values | object | 是 | 保存后读回的字段值,键为字段 ID。图片、附件字段的值是数组,每项含 url、name 等文件信息 |
data.items[].qrcode_image_url | string | 是 | 二维码图片地址,带时效签名;status 不是 succeeded 或暂时取不到图片时为 null |
data.page | integer | 是 | 当前页码,从 1 开始 |
data.page_size | integer | 是 | 每页条数 |
data.has_more | boolean | 是 | 是否还有下一页。为 true 时即使当前页为空也应继续翻页 |
响应示例
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,
"items": [
{
"item_key": "row-1",
"qrcode_id": "7002001",
"coding": "qCh0001",
"web_url": "https://qr61.cn/oAbCdE/qCh0001",
"name": "1 号空压机",
"status": "succeeded",
"error": null,
"values": {
"71399639089153": "1 号空压机"
},
"qrcode_image_url": "https://qr.api.cli.im/newqr/create?data=https%3A%2F%2Fqr61.cn%2FoAbCdE%2FqXyZ123&sign=EXAMPLE"
},
{
"item_key": "row-2",
"qrcode_id": "7002002",
"coding": "qCh0002",
"web_url": "https://qr61.cn/oAbCdE/qCh0002",
"name": "2 号空压机",
"status": "content_pending",
"error": {
"code": "CONTENT_NOT_READY",
"message": "码已创建,输入字段或附件尚未全部核对就绪"
},
"values": {},
"qrcode_image_url": null
}
],
"page": 1,
"page_size": 20,
"has_more": false
}
}常见错误
TASK_NOT_FOUND、TASK_RECEIPT_EXPIRED、TASK_SERVICE_UNAVAILABLE、TASK_RESULTS_UNAVAILABLE、CONTENT_NOT_READY、BATCH_TASK_FAILED。含义和处理方式见业务错误码。
本页由 openapi.json 生成。全部接口见接口清单。