Skip to content

分页读取批量建码逐项结果 ​

按输入顺序分页返回批量建码每一项的结果:item_key 对应的码 ID、coding、web_url 和实际字段值。content_pending 的项需继续查询;回执 24 小时后过期。

请求 ​

text
POST https://open.cli.im/api/v2/rpc/qrcodeTasks/getResults
项目要求
最低权限读写,见权限档位
需要的 scopeqrcodes.write
组织 Key不能调用,返回 403 credential_type_not_allowed,见历史组织 Key

相关调用流程:按模板批量建码。

请求参数 ​

请求体为 JSON。

字段类型必填说明
task_idstring是任务 ID,取自 qrcodes/createBatch 或 gallery/create-from-plan 的返回。最长 128 个字符
pageinteger否页码,从 1 开始。默认 1。最小 1
page_sizeinteger否每页条数。默认 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_idstring是任务 ID,用于 qrcodeTasks/get 和 qrcodeTasks/getResults
data.batch_idstring是批次 ID
data.template_idstring是模板 ID
data.totalinteger是本批提交的条数
data.receipt_expires_atinteger是任务回执的过期时间(Unix 秒),过期后不能再查询逐项结果
data.statusstring是任务状态:queued 排队中;running 处理中;succeeded 已结束;failed 失败;cancelled 已取消。succeeded 只表示任务结束,每一项是否建好以 qrcodeTasks/getResults 为准。可选值:queued、running、succeeded、failed、cancelled
data.progressinteger是进度百分比,0 到 100
data.processed_countinteger是已处理的条数;取不到时为 null
data.created_atany是任务创建时间;取不到时为 null
data.updated_atany是任务最近更新时间;取不到时为 null
data.completion_scopestring是固定为 batch_task,表示 status 描述的是整批任务,不是每一项
data.poll_after_secondsinteger是建议的轮询间隔(秒)
data.errorsobject[]否未成功或未确认的部分;全部成功时为空数组
data.errors[].codestring是错误码,含义见规范顶层的 x-error-catalog
data.errors[].pathstring否出错字段在请求体中的位置,如 items.0.values.12345;没有具体位置时为空字符串
data.errors[].item_keystring否批量数据中出错那一项的 item_key;不针对某一项时为空字符串
data.errors[].retryableboolean否原样重试是否可能成功
data.errors[].next_actionstring否建议的下一步:correct_input 修正入参;retry_later 稍后重试;retry_same_idempotency_key 用原幂等键重试;inspect_created_qrcode、inspect_created_form、inspect_result 先读取已保存的内容核对
data.errors[].messagestring否补充说明,部分错误才有
data.itemsobject[]是本页各项的结果,顺序与提交时一致
data.items[].item_keystring是提交时的 item_key
data.items[].qrcode_idstring是建好的码 ID;尚未建好或无法确认时为 null
data.items[].codingstring是码的短编号,用于按编号查询内容(如 qrcodes/getContent 的 qrcode 参数)
data.items[].web_urlstring是码的扫码地址,即二维码里编码的网址
data.items[].namestring是码名称
data.items[].statusstring是pending 处理中;succeeded 已建好且内容已核对;content_pending 码已建好,内容仍在保存,需继续查询;unknown 无法确认结果;unavailable 码已被删除、移动或无权读取。可选值:pending、succeeded、content_pending、unknown、unavailable
data.items[].errorobject是status 不是 succeeded 或 pending 时的原因
data.items[].error.codestring是错误码
data.items[].error.messagestring是说明
data.items[].valuesobject是保存后读回的字段值,键为字段 ID。图片、附件字段的值是数组,每项含 url、name 等文件信息
data.items[].qrcode_image_urlstring是二维码图片地址,带时效签名;status 不是 succeeded 或暂时取不到图片时为 null
data.pageinteger是当前页码,从 1 开始
data.page_sizeinteger是每页条数
data.has_moreboolean是是否还有下一页。为 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 生成。全部接口见接口清单。