用官方模板生成单个码
用官方模板生成单个码:码内容、表单和状态按模板原样安装,不填逐码数据,仅 compatibility.can_create_single 为 true 的模板可用。需要幂等键 idempotency_key,结果未知时用原键核对;返回 qrcode_id、web_url 和随安装新建的 form_ids。
请求
text
POST https://open.cli.im/api/v2/rpc/gallery/create-qrcode| 项目 | 要求 |
|---|---|
| 最低权限 | 读写,见权限档位 |
| 需要的 scope | templates.write、qrcodes.write |
| 组织 Key | 不能调用,返回 403 credential_type_not_allowed,见历史组织 Key |
请求参数
请求体为 JSON。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
gallery_template_id | string | 是 | 官方模板 ID,取自 gallery/list;不是账号内模板的 template_id |
idempotency_key | string | 是 | 幂等键,由调用方生成,1 到 128 位,只能包含字母、数字和 _ . : -。同一个键重复提交会返回第一次的结果,不会重复创建;请求超时或结果不明时用原键和原参数重试,新的请求换一个新键。最长 128 个字符 |
project_id | integer | 否 | 分区 ID,0 为默认分区(不代表全部分区)。可用的分区用 qrcodes/listCreateTargets 查询。默认 0 |
category_id | integer | 否 | 目录 ID;不传或传 0 放在默认位置。可用的目录用 qrcodes/listCreateTargets(kind=categories)查询。默认 0 |
name | string | 否 | 码名称;不传沿用模板名称。最长 100 个字符 |
请求示例
示例里的 ID、幂等键等换成实际值。
bash
curl -sS -X POST 'https://open.cli.im/api/v2/rpc/gallery/create-qrcode' \
-H "Authorization: Bearer ${CAOLIAO_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
"gallery_template_id": "30128",
"idempotency_key": "gallery-single-001",
"project_id": 0,
"name": "1 号空压机"
}'响应
成功时 HTTP 状态码为 200,顶层 code 为 0,结果在 data 里。失败时的返回见错误码与调用额度和业务错误码。
| 字段 | 类型 | 一定返回 | 说明 |
|---|---|---|---|
data.qrcode_id | string | 是 | 码 ID |
data.coding | string | 是 | 码的短编号,用于按编号查询内容(如 qrcodes/getContent 的 qrcode 参数) |
data.web_url | string | 是 | 码的扫码地址,即二维码里编码的网址 |
data.name | string | 是 | 码名称 |
data.gallery_template_id | string | 是 | 官方模板 ID |
data.form_ids | 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.creation_usage | object | 否 | 本次操作计入当日额度的新建数量 |
data.creation_usage.templates | integer | 否 | 新建的模板数 |
data.creation_usage.forms | integer | 否 | 新建的表单数 |
data.creation_usage.qrcodes | integer | 否 | 新建的码数 |
响应示例
json
{
"code": 0,
"message": "ok",
"data": {
"qrcode_id": "7001240",
"coding": "qGal001",
"web_url": "https://qr61.cn/oAbCdE/qGal001",
"name": "1 号空压机",
"gallery_template_id": "30128",
"form_ids": [
"122610"
],
"status": "succeeded",
"errors": [],
"warnings": [],
"creation_usage": {
"qrcodes": 1,
"forms": 1
}
}
}常见错误
PERMISSION_DENIED、ACCESS_LEVEL_READ_ONLY、quota_exceeded、IDEMPOTENCY_CONFLICT、IDEMPOTENCY_IN_PROGRESS、IDEMPOTENCY_OUTCOME_UNKNOWN、GALLERY_TEMPLATE_NOT_FOUND、GALLERY_SINGLE_INSTALL_UNSUPPORTED、GALLERY_INSTALL_FAILED、CATEGORY_DENIED、AI_ORIGIN_MARK_FAILED。含义和处理方式见业务错误码。
本页由 openapi.json 生成。全部接口见接口清单。