读取当前标签样式与支持的导出格式
读取普通码、子码或母模板当前关联标签的样式、尺寸、展示字段和 supported_formats。只读,不保存或修改样式;导出格式以这里实际返回的为准。
请求
text
POST https://open.cli.im/api/v2/rpc/labels/getConfig| 项目 | 要求 |
|---|---|
| 最低权限 | 只读,见权限档位 |
| 需要的 scope | templates.read |
| 组织 Key | 不能调用,返回 403 credential_type_not_allowed,见历史组织 Key |
相关调用流程:导出可打印的标签。
请求参数
请求体为 JSON。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
qrcode_id | string | 是 | 普通码、子码或批量模板的 ID。最长 128 个字符 |
请求示例
示例里的 ID、幂等键等换成实际值。
bash
curl -sS -X POST 'https://open.cli.im/api/v2/rpc/labels/getConfig' \
-H "Authorization: Bearer ${CAOLIAO_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
"qrcode_id": "7001234"
}'响应
成功时 HTTP 状态码为 200,顶层 code 为 0,结果在 data 里。失败时的返回见错误码与调用额度和业务错误码。
| 字段 | 类型 | 一定返回 | 说明 |
|---|---|---|---|
data.qrcode_id | string | 是 | 码 ID |
data.target_type | string | 是 | normal 普通码;template_children 批量模板或其子码。可选值:normal、template_children |
data.style | object | 是 | 当前关联的标签样式 |
data.style.id | string | 是 | 样式 ID |
data.style.name | string | 是 | 样式名称 |
data.style.size | object | 是 | 标签尺寸 |
data.style.size.width | any | 否 | 宽 |
data.style.size.height | any | 否 | 高 |
data.style.size.unit | any | 否 | 单位 |
data.format_options | object | 是 | 各导出格式对应的尺寸,键为格式名 |
data.fields | object[] | 是 | 标签上展示的字段 |
data.fields[].name | string | 是 | 字段名称 |
data.fields[].source | string | 是 | 字段来源 |
data.fields[].field_id | string | 是 | 字段 ID |
data.supported_formats | string[] | 是 | 当前样式支持的导出格式 |
data.limits | object | 是 | 数量限制 |
data.limits.preview_max_targets | integer | 是 | 一次最多预览几个码 |
data.limits.export_max_targets | integer | 是 | 一次最多导出几个码 |
data.limits.copies_per_target | integer | 是 | 每个码导出的份数 |
响应示例
json
{
"code": 0,
"message": "ok",
"data": {
"qrcode_id": "7001234",
"target_type": "normal",
"style": {
"id": "5521",
"name": "设备标签 60×40",
"size": {
"width": 60,
"height": 40,
"unit": "mm"
}
},
"format_options": {
"png_zip": {
"style_size_id": 81,
"size": {
"width": 60,
"height": 40,
"unit": "mm"
}
}
},
"fields": [
{
"name": "设备名称",
"source": "basicInfo",
"field_id": "71399639089153"
}
],
"supported_formats": [
"png_zip",
"a4_pdf"
],
"limits": {
"preview_max_targets": 1,
"export_max_targets": 1,
"copies_per_target": 1
}
}
}常见错误
QRCODE_NOT_FOUND、LABEL_STYLE_NOT_CONFIGURED、LABEL_TARGETS_MUST_SHARE_TEMPLATE。含义和处理方式见业务错误码。
本页由 openapi.json 生成。全部接口见接口清单。