Skip to content

按当前样式预览指定码的标签 ​

按当前标签样式为指定的码生成预览:普通码每次 1 个,同一母模板的子码最多 3 个,两者不能混用。会生成临时预览文件,不保存或切换样式。

请求 ​

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

相关调用流程:导出可打印的标签。

请求参数 ​

请求体为 JSON。

字段类型必填说明
qrcode_idsstring[]是要预览的码 ID:普通码每次 1 个,同一批量模板的子码最多 3 个;不能传批量模板的 ID。至少 1 项。最多 3 项

请求示例 ​

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

bash
curl -sS -X POST 'https://open.cli.im/api/v2/rpc/labels/preview' \
  -H "Authorization: Bearer ${CAOLIAO_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "qrcode_ids": [
    "7001234"
  ]
}'

响应 ​

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

字段类型一定返回说明
data.itemsobject[]是每个码的预览
data.items[].qrcode_idstring是码 ID
data.items[].preview_urlstring是标签预览图地址,带时效签名
data.warningsobject[]是不影响结果的提示;没有时为空数组
data.warnings[].codestring是提示码
data.warnings[].messagestring否提示说明
data.warnings[].pathstring否相关字段在请求体中的位置
data.warnings[].next_actionstring否建议的下一步

响应示例 ​

json
{
  "code": 0,
  "message": "ok",
  "data": {
    "items": [
      {
        "qrcode_id": "7001234",
        "preview_url": "https://ncstatic.clewm.net/label/preview/example.png?sign=EXAMPLE"
      }
    ],
    "warnings": []
  }
}

常见错误 ​

QRCODE_NOT_FOUND、LABEL_STYLE_NOT_CONFIGURED、LABEL_TARGETS_MUST_SHARE_TEMPLATE、LABEL_TARGET_NOT_READY、LABEL_READONLY_UNSUPPORTED。含义和处理方式见业务错误码。


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