修改码之前读取当前内容、版本和是否可改
修改码之前先调用:返回 kind(plain/url_jump/multi_url/child)、当前内容、version、editable 和 reason。默认只能修改通过接口创建的码;修改人工创建的内容需要“完全”档凭证,缺少时 reason 为 AI_EDIT_SCOPE_REQUIRED。
请求
text
POST https://open.cli.im/api/v2/rpc/qrcodes/getEditState| 项目 | 要求 |
|---|---|
| 最低权限 | 读写,见权限档位 |
| 需要的 scope | qrcodes.write |
| 组织 Key | 不能调用,返回 403 credential_type_not_allowed,见历史组织 Key |
相关调用流程:修改和删除码、表单。
请求参数
请求体为 JSON。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
qrcode_id | string | 是 | 普通码、网址跳转码、网址聚合码或子码的 ID。批量模板请用 templates/getSchema。最长 128 个字符 |
请求示例
示例里的 ID、幂等键等换成实际值。
bash
curl -sS -X POST 'https://open.cli.im/api/v2/rpc/qrcodes/getEditState' \
-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.kind | string | 是 | 码的类型,决定用哪个接口修改:plain 普通码或图文展示码(qrcodes/edit);url_jump 网址跳转码(qrcodes/editUrlJump);multi_url 网址聚合码(qrcodes/editMultiUrl);child 批量生成的子码(qrcodeChildren/edit)。可选值:plain、url_jump、multi_url、child |
data.project_id | string | 是 | 所在分区 ID |
data.name | string | 是 | 码名称 |
data.coding | string | 是 | 码的短编号,用于按编号查询内容(如 qrcodes/getContent 的 qrcode 参数) |
data.web_url | 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.links | object[] | 否 | kind 为 url_jump 或 multi_url 时的链接;跳转码只有一条 |
data.links[].title | string | 是 | 链接标题 |
data.links[].url | string | 是 | 链接地址 |
data.fields | object[] | 否 | 子码可填写的字段及当前值 |
data.fields[].field_id | string | 是 | 字段 ID |
data.fields[].name | string | 是 | 字段名称 |
data.fields[].type | string | 是 | 字段类型 |
data.fields[].required | boolean | 是 | 是否必填 |
data.fields[].value | any | 是 | 当前值;未填写时为 null。图片、附件字段的值是数组,每项含 url、name 等文件信息 |
data.version | string | 是 | 内容版本。修改时原样传回;内容变化后版本随之变化,需要重新读取 |
data.editable | boolean | 是 | 当前凭证能否修改这个码 |
data.reason | string | 是 | 不能修改的原因:AI_EDIT_NOT_AI_CREATED 不是通过接口创建的内容;AI_EDIT_SCOPE_REQUIRED 需要“完全”档凭证。可以修改时为 null |
响应示例
json
{
"code": 0,
"message": "ok",
"data": {
"qrcode_id": "7001234",
"kind": "plain",
"project_id": "0",
"name": "1 号空压机",
"coding": "qXyZ123",
"web_url": "https://qr61.cn/oAbCdE/qXyZ123",
"components": [
{
"ref": "c_9101",
"type": "rich_text",
"html": "<h2>操作须知</h2><p>开机前检查油位。</p>"
},
{
"ref": "c_9102",
"type": "basic_info"
},
{
"ref": "c_9103",
"type": "gallery",
"items": [
{
"url": "https://ncstatic.clewm.net/rsrc/2026/1118/10/example.jpg"
}
]
}
],
"version": "c_5f2b9c0e7a1d4c3b8e6f0a9d2c4b6e8f1a3c5e7090b1d2f3a4c5e6f708192a3b",
"editable": true,
"reason": null
}
}常见错误
PERMISSION_DENIED、QRCODE_NOT_FOUND、QRCODE_KIND_MISMATCH。含义和处理方式见业务错误码。
本页由 openapi.json 生成。全部接口见接口清单。