Skip to content

批量建码预校验,不创建码 ​

校验已有模板的批量建码数据(最多 100 行),不创建码。需要 templates/getSchema 返回的 template_version;传 save_plan=true 时校验通过会返回 30 分钟有效的 plan_id,供 qrcodes/createBatch 提交。

请求 ​

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

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

请求参数 ​

请求体为 JSON。

字段类型必填说明
template_idstring是模板 ID,取自 templates/listEditable 或 templates/list 返回的 template_id。最长 128 个字符
save_planboolean否校验通过后是否保存为建码方案,默认 false。为 true 时返回 30 分钟内有效的 plan_id,提交时只需要传 plan_id。默认 false
template_versionstring是模板版本,取自 templates/getSchema 返回的 template_version;模板变化后需要重新读取。最长 128 个字符
category_idinteger否子码存放的目录 ID。不传或传 0 时放入与模板同名的目录。默认 0
itemsobject[]是要校验的数据,1 到 100 项。至少 1 项。最多 100 项
items[].item_keystring是这一项的标识,由调用方自定,同一批内不能重复;查询逐项结果时按它对应。最长 128 个字符
items[].namestring否码名称,最长 100 字,可以不传。最长 100 个字符
items[].valuesobject是字段值,键为 field_id:已有模板取自 templates/getSchema,官方模板取自 gallery/get 的 creation_schema。文本传字符串,数字传数字,日期传 YYYY-MM-DD,图片和附件传 [{"file_key": ...}],不接受外部网址

请求示例 ​

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

bash
curl -sS -X POST 'https://open.cli.im/api/v2/rpc/qrcodes/prevalidate' \
  -H "Authorization: Bearer ${CAOLIAO_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "template_id": "6801234",
  "template_version": "v_7c1e0f5a9b3d4e6f8a0b2c4d6e8f0a1b3c5d7e9f1a2b4c6d8e0f1a3b5c7d9e0f",
  "save_plan": true,
  "items": [
    {
      "item_key": "row-1",
      "name": "1 号空压机",
      "values": {
        "71399639089153": "1 号空压机"
      }
    },
    {
      "item_key": "row-2",
      "name": "2 号空压机",
      "values": {
        "71399639089153": "2 号空压机"
      }
    }
  ]
}'

响应 ​

成功时 HTTP 状态码为 200,顶层 code 为 0,结果在 data 里。失败时的返回见错误码与调用额度和业务错误码。

字段类型一定返回说明
data.validboolean是数据是否全部通过校验
data.requested_countinteger是本次提交的条数
data.errorsobject[]是未通过校验的问题,按 path 定位;为空表示全部通过
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.warningsobject[]是不阻止建码的提示,如名称重复
data.warnings[].codestring是错误码,含义见规范顶层的 x-error-catalog
data.warnings[].pathstring否出错字段在请求体中的位置,如 items.0.values.12345;没有具体位置时为空字符串
data.warnings[].item_keystring否批量数据中出错那一项的 item_key;不针对某一项时为空字符串
data.warnings[].retryableboolean否原样重试是否可能成功
data.warnings[].next_actionstring否建议的下一步:correct_input 修正入参;retry_later 稍后重试;retry_same_idempotency_key 用原幂等键重试;inspect_created_qrcode、inspect_created_form、inspect_result 先读取已保存的内容核对
data.warnings[].messagestring否补充说明,部分错误才有
data.field_mappingobject是可填写的字段 ID 列表(键和值相同)
data.samplesany[]是请求中前 3 条数据,便于核对
data.plan_idstring否建码方案 ID,30 分钟内有效,传给 qrcodes/createBatch。save_plan 为 true 且校验通过时返回
data.expires_atinteger否方案的过期时间(Unix 秒)
data.item_countinteger否方案里的条数

响应示例 ​

json
{
  "code": 0,
  "message": "ok",
  "data": {
    "valid": true,
    "requested_count": 2,
    "errors": [],
    "warnings": [],
    "field_mapping": {
      "71399639089153": "71399639089153",
      "71399639089154": "71399639089154"
    },
    "samples": [
      {
        "item_key": "row-1",
        "name": "1 号空压机",
        "values": {
          "71399639089153": "1 号空压机"
        }
      },
      {
        "item_key": "row-2",
        "name": "2 号空压机",
        "values": {
          "71399639089153": "2 号空压机"
        }
      }
    ],
    "plan_id": "batch_plan_0123456789abcdef0123456789abcdef",
    "expires_at": 1795001800,
    "item_count": 2
  }
}

常见错误 ​

TEMPLATE_NOT_FOUND、TEMPLATE_LOCKED、PERMISSION_DENIED、TEMPLATE_VERSION_CONFLICT、TEMPLATE_UNSUPPORTED、CATEGORY_DENIED、BATCH_CYCLE_OVERRIDE_UNSUPPORTED、UNKNOWN_FIELD、REQUIRED_FIELD、INVALID_TYPE、INVALID_ASSET、DUPLICATE_ITEM_KEY、BATCH_LIMIT、ASSET_UNAVAILABLE、ASSET_LIMIT_EXCEEDED。含义和处理方式见业务错误码。


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