创建普通图文码并绑定表单
创建普通码或图文展示码:components 支持富文本、图片、图集、文件和按钮,可通过 forms 绑定已有表单。图片和文件先用 assets/requestUpload 上传并引用 file_key。需要幂等键 idempotency_key;partial_success 时保留已建的 qrcode_id,不要另建。
请求
text
POST https://open.cli.im/api/v2/rpc/qrcodes/create| 项目 | 要求 |
|---|---|
| 最低权限 | 读写,见权限档位 |
| 需要的 scope | qrcodes.write |
| 组织 Key | 不能调用,返回 403 credential_type_not_allowed,见历史组织 Key |
相关调用流程:按模板批量建码。
请求参数
请求体为 JSON。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
idempotency_key | string | 是 | 幂等键,由调用方生成,1 到 128 位,只能包含字母、数字和 _ . : -。同一个键重复提交会返回第一次的结果,不会重复创建;请求超时或结果不明时用原键和原参数重试,新的请求换一个新键。最长 128 个字符 |
name | string | 是 | 码名称。最长 100 个字符 |
project_id | integer | 否 | 分区 ID,0 为默认分区(不代表全部分区)。可用的分区用 qrcodes/listCreateTargets 查询。默认 0 |
category_id | integer | 否 | 目录 ID;不传或传 0 放在默认位置。可用的目录用 qrcodes/listCreateTargets(kind=categories)查询。默认 0 |
groups | object[] | 否 | 基础信息分组,最多 20 个;可以不传。最多 20 项 |
groups[].group_id | string | 是 | 分组标识,由调用方自定。最长 128 个字符 |
groups[].name | string | 是 | 分组名称,可以是空字符串。最长 200 个字符 |
groups[].fields | object[] | 是 | 分组内的字段,1 到 100 个。至少 1 项。最多 100 项 |
groups[].fields[].field_id | string | 是 | 字段标识,由调用方自定(字母、数字、下划线、短横线);返回的 values 以它为键。最长 128 个字符 |
groups[].fields[].name | string | 是 | 字段名称。最长 100 个字符 |
groups[].fields[].type | string | 是 | 字段类型:text 单行文本、textarea 多行文本、number 数字、date 日期(YYYY-MM-DD)、image 图片、file 附件。可选值:text、textarea、number、date、image、file |
groups[].fields[].required | boolean | 否 | 是否必填,默认 false。默认 false |
groups[].fields[].variable | 固定值 false | 否 | 固定为 false,可以不传。默认 false |
groups[].fields[].public_value | any | 是 | 字段内容。文本传字符串,数字传数字,日期传 YYYY-MM-DD,图片和附件传 [{"file_key": ...}] |
components | object[] | 否 | 页面上的图文内容,按顺序排列富文本、图片、图集、文件和按钮。用 basic_info 标出基础信息的位置,不标时基础信息在最前;绑定的表单入口在最后。最多 50 项 |
forms | object[] | 否 | 要绑定的已有表单,最多 10 个。需要按周期填写时,先用 forms/create 创建带周期的表单。最多 10 项 |
forms[].form_id | string | 是 | 要绑定的表单 ID,取自 forms/create 或 record/getFormList |
forms[].title | string | 是 | 页面上填写按钮的文字。最长 100 个字符 |
components 中 type 为 rich_text 的项
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
components[].type | 固定值 "rich_text" | 是 | 固定为 rich_text,富文本 |
components[].blocks | object[] | 是 | 内容块,按顺序排列:标题、段落或列表。至少 1 项。最多 100 项 |
components[].blocks 的一种写法(DisplayTextBlock)
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
components[].blocks[].type | string | 是 | heading 标题;paragraph 段落。可选值:heading、paragraph |
components[].blocks[].text | string | 是 | 纯文本,不解析 HTML 或 Markdown。最长 10000 个字符 |
components[].blocks 的一种写法(DisplayListBlock)
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
components[].blocks[].type | string | 是 | bullet_list 无序列表;numbered_list 有序列表。可选值:bullet_list、numbered_list |
components[].blocks[].items | string[] | 是 | 列表项,纯文本。至少 1 项。最多 100 项 |
components 中 type 为 image 的项
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
components[].file_key | string | 是 | 图片的 file_key,取自 assets/requestUpload,并已由 assets/getUpload 确认状态为 temporary_available。不接受外部网址。最长 512 个字符 |
components[].type | 固定值 "image" | 是 | 固定为 image,单张图片 |
components 中 type 为 file 的项
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
components[].file_key | string | 是 | 文件的 file_key,取自 assets/requestUpload,并已确认状态为 temporary_available。页面上显示上传时的文件名,默认允许下载;不接受外部网址。最长 512 个字符 |
components[].type | 固定值 "file" | 是 | 固定为 file,文件 |
components 中 type 为 gallery 的项
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
components[].type | 固定值 "gallery" | 是 | 固定为 gallery,图集 |
components[].items | object[] | 是 | 图片,1 到 10 张。至少 1 项。最多 10 项 |
components[].items[].file_key | string | 是 | 图片的 file_key,取自 assets/requestUpload,并已由 assets/getUpload 确认状态为 temporary_available。不接受外部网址。最长 512 个字符 |
components 中 type 为 button 的项
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
components[].type | 固定值 "button" | 是 | 固定为 button,链接按钮 |
components[].text | string | 是 | 按钮文字。最长 100 个字符 |
components[].url | string | 是 | 按钮跳转的地址,须为绝对 HTTP(S) 地址且只含 ASCII 字符:中文域名用 punycode,中文路径和参数用百分号编码;不能带登录凭证。最长 2048 个字符 |
components 中 type 为 basic_info 的项
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
components[].type | 固定值 "basic_info" | 是 | 固定为 basic_info,标出基础信息(groups)在页面上的位置;最多一个,且 groups 不能为空 |
请求示例
示例里的 ID、幂等键等换成实际值。
bash
curl -sS -X POST 'https://open.cli.im/api/v2/rpc/qrcodes/create' \
-H "Authorization: Bearer ${CAOLIAO_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
"idempotency_key": "qr-compressor-001",
"name": "1 号空压机",
"project_id": 0,
"groups": [
{
"group_id": "info",
"name": "设备信息",
"fields": [
{
"field_id": "model",
"name": "型号",
"type": "text",
"public_value": "GA37"
}
]
}
],
"components": [
{
"type": "rich_text",
"blocks": [
{
"type": "heading",
"text": "操作须知"
},
{
"type": "paragraph",
"text": "开机前检查油位。"
}
]
},
{
"type": "basic_info"
},
{
"type": "image",
"file_key": "free/2026/11/18/3f9a1c7e5b2d4a6c8e0f.jpg"
}
],
"forms": [
{
"form_id": "122507",
"title": "填写巡检记录"
}
]
}'响应
成功时 HTTP 状态码为 200,顶层 code 为 0,结果在 data 里。失败时的返回见错误码与调用额度和业务错误码。
| 字段 | 类型 | 一定返回 | 说明 |
|---|---|---|---|
data.qrcode_id | string | 是 | 码 ID |
data.coding | string | 是 | 码的短编号,用于按编号查询内容(如 qrcodes/getContent 的 qrcode 参数) |
data.web_url | string | 是 | 码的扫码地址,即二维码里编码的网址 |
data.values | object | 是 | 保存后读回的基础信息内容,键为请求里的 field_id |
data.forms | object[] | 是 | 已绑定的表单 |
data.forms[].form_id | string | 是 | 表单 ID |
data.forms[].title | string | 是 | 填写按钮标题 |
data.status | string | 是 | 处理结果:succeeded 全部成功;partial_success 主体已保存,但有未确认的部分,见 errors。可选值:succeeded、partial_success |
data.errors | object[] | 是 | 未成功或未确认的部分;全部成功时为空数组 |
data.errors[].code | string | 是 | 错误码,含义见规范顶层的 x-error-catalog |
data.errors[].path | string | 否 | 出错字段在请求体中的位置,如 items.0.values.12345;没有具体位置时为空字符串 |
data.errors[].item_key | string | 否 | 批量数据中出错那一项的 item_key;不针对某一项时为空字符串 |
data.errors[].retryable | boolean | 否 | 原样重试是否可能成功 |
data.errors[].next_action | string | 否 | 建议的下一步:correct_input 修正入参;retry_later 稍后重试;retry_same_idempotency_key 用原幂等键重试;inspect_created_qrcode、inspect_created_form、inspect_result 先读取已保存的内容核对 |
data.errors[].message | string | 否 | 补充说明,部分错误才有 |
data.warnings | object[] | 否 | 不影响结果的提示;没有时为空数组 |
data.warnings[].code | string | 是 | 提示码 |
data.warnings[].message | string | 否 | 提示说明 |
data.warnings[].path | string | 否 | 相关字段在请求体中的位置 |
data.warnings[].next_action | string | 否 | 建议的下一步 |
data.components | object[] | 否 | 页面上可通过接口管理的图文组件,按页面顺序 |
data.components[].ref | string | 否 | 组件引用,如 c_123。修改时用 {"type":"keep","ref":...} 保留该组件,或在新内容上带 ref 原地替换 |
data.components[].type | string | 是 | 组件类型:basic_info 基础信息;rich_text 富文本;gallery 图片或图集;file 文件;button 链接按钮。可选值:basic_info、rich_text、gallery、file、button |
data.components[].html | string | 否 | rich_text:保存后的富文本 HTML |
data.components[].items | object[] | 否 | gallery:图片列表 |
data.components[].items[].url | string | 是 | 图片地址 |
data.components[].url | string | 否 | file:文件地址;button:跳转地址 |
data.components[].name | string | 否 | file:文件名 |
data.components[].text | string | 否 | button:按钮文字 |
data.qrcode_image_url | string | 是 | 二维码图片地址,带时效签名;status 不是 succeeded 或暂时取不到图片时为 null |
响应示例
json
{
"code": 0,
"message": "ok",
"data": {
"qrcode_id": "7001234",
"coding": "qXyZ123",
"web_url": "https://qr61.cn/oAbCdE/qXyZ123",
"values": {
"model": "GA37"
},
"forms": [
{
"form_id": "122507",
"title": "填写巡检记录"
}
],
"status": "succeeded",
"errors": [],
"warnings": [],
"components": [
{
"type": "rich_text",
"html": "<h2>操作须知</h2><p>开机前检查油位。</p>"
},
{
"type": "basic_info"
},
{
"type": "gallery",
"items": [
{
"url": "https://ncstatic.clewm.net/rsrc/2026/1118/10/example.jpg"
}
]
}
],
"qrcode_image_url": "https://qr.api.cli.im/newqr/create?data=https%3A%2F%2Fqr61.cn%2FoAbCdE%2FqXyZ123&sign=EXAMPLE"
}
}常见错误
PERMISSION_DENIED、ACCESS_LEVEL_READ_ONLY、quota_exceeded、IDEMPOTENCY_CONFLICT、IDEMPOTENCY_IN_PROGRESS、IDEMPOTENCY_OUTCOME_UNKNOWN、CATEGORY_DENIED、URL_BLOCKED、ASSET_UNAVAILABLE、QRCODE_CONTENT_UNCONFIRMED、FORM_BINDING_UNCONFIRMED、AI_ORIGIN_MARK_FAILED。含义和处理方式见业务错误码。
本页由 openapi.json 生成。全部接口见接口清单。