创建网址聚合码
创建网址聚合码(活码):扫码打开链接清单页,按 links 顺序列出 1 到 100 个带标题的网址。任一网址命中平台禁用域名则整体返回 URL_BLOCKED。需要幂等键 idempotency_key。
请求
text
POST https://open.cli.im/api/v2/rpc/qrcodes/createMultiUrl| 项目 | 要求 |
|---|---|
| 最低权限 | 读写,见权限档位 |
| 需要的 scope | qrcodes.write |
| 组织 Key | 不能调用,返回 403 credential_type_not_allowed,见历史组织 Key |
相关调用流程:按模板批量建码。
请求参数
请求体为 JSON。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
idempotency_key | string | 是 | 幂等键,由调用方生成,1 到 128 位,只能包含字母、数字和 _ . : -。同一个键重复提交会返回第一次的结果,不会重复创建;请求超时或结果不明时用原键和原参数重试,新的请求换一个新键。最长 128 个字符 |
name | string | 是 | 码名称。最长 100 个字符 |
links | object[] | 是 | 扫码后链接清单页展示的链接,按数组顺序排列,最多 100 条。至少 1 项。最多 100 项 |
links[].title | string | 是 | 清单页显示的链接标题。最长 100 个字符 |
links[].url | string | 是 | 链接地址,须为绝对 HTTP(S) 地址且只含 ASCII 字符:中文域名用 punycode,中文路径和参数用百分号编码。最长 2048 个字符 |
project_id | integer | 否 | 分区 ID,0 为默认分区(不代表全部分区)。可用的分区用 qrcodes/listCreateTargets 查询。默认 0 |
category_id | integer | 否 | 目录 ID;不传或传 0 放在默认位置。可用的目录用 qrcodes/listCreateTargets(kind=categories)查询。默认 0 |
请求示例
示例里的 ID、幂等键等换成实际值。
bash
curl -sS -X POST 'https://open.cli.im/api/v2/rpc/qrcodes/createMultiUrl' \
-H "Authorization: Bearer ${CAOLIAO_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
"idempotency_key": "qr-links-001",
"name": "常用链接",
"links": [
{
"title": "官网",
"url": "https://www.example.com/"
},
{
"title": "帮助中心",
"url": "https://help.example.com/"
}
]
}'响应
成功时 HTTP 状态码为 200,顶层 code 为 0,结果在 data 里。失败时的返回见错误码与调用额度和业务错误码。
| 字段 | 类型 | 一定返回 | 说明 |
|---|---|---|---|
data.qrcode_id | string | 是 | 码 ID |
data.coding | string | 是 | 码的短编号,用于按编号查询内容(如 qrcodes/getContent 的 qrcode 参数) |
data.web_url | string | 是 | 码的扫码地址,即二维码里编码的网址 |
data.name | string | 是 | 码名称 |
data.links | object[] | 是 | 链接清单 |
data.links[].title | string | 是 | 链接标题 |
data.links[].url | 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.qrcode_image_url | string | 是 | 二维码图片地址,带时效签名;status 不是 succeeded 或暂时取不到图片时为 null |
响应示例
json
{
"code": 0,
"message": "ok",
"data": {
"qrcode_id": "7001236",
"coding": "qMul789",
"web_url": "https://qr61.cn/oAbCdE/qMul789",
"name": "常用链接",
"links": [
{
"title": "官网",
"url": "https://www.example.com/"
},
{
"title": "帮助中心",
"url": "https://help.example.com/"
}
],
"status": "succeeded",
"errors": [],
"warnings": [],
"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、QRCODE_CONTENT_UNCONFIRMED、AI_ORIGIN_MARK_FAILED。含义和处理方式见业务错误码。
本页由 openapi.json 生成。全部接口见接口清单。