Skip to content

查询建码任务进度 ​

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

请求 ​

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

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

请求参数 ​

请求体为 JSON。

字段类型必填说明
task_idstring是任务 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 里。失败时的返回见错误码与调用额度和业务错误码。

字段类型一定返回说明
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否补充说明,部分错误才有

响应示例 ​

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。含义和处理方式见业务错误码。


本页由 openapi.json 生成。全部接口见接口清单。