创建文本或网址静态码
创建静态码:content 直接编码进二维码,创建后不能修改,没有扫码统计,不能绑定表单。type=text 为文本,url 为网址。需要幂等键 idempotency_key,同一幂等键重试返回原结果。
请求
text
POST https://open.cli.im/api/v2/rpc/staticQrcodes/create| 项目 | 要求 |
|---|---|
| 最低权限 | 读写,见权限档位 |
| 需要的 scope | qrcodes.write |
| 组织 Key | 不能调用,返回 403 credential_type_not_allowed,见历史组织 Key |
相关调用流程:按模板批量建码。
请求参数
请求体为 JSON。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
idempotency_key | string | 是 | 幂等键,由调用方生成,1 到 128 位,只能包含字母、数字和 _ . : -。同一个键重复提交会返回第一次的结果,不会重复创建;请求超时或结果不明时用原键和原参数重试,新的请求换一个新键。最长 128 个字符 |
type | string | 是 | text 文本静态码;url 网址静态码(扫码由手机直接打开,不经过草料)。可选值:text、url |
content | string | 是 | 直接编码进二维码的内容,创建后不能修改,首尾空白会去掉。type 为 text 时不超过 1500 个 UTF-8 字节(约 500 个汉字);type 为 url 时须为绝对 HTTP(S) 地址且只含 ASCII 字符。最长 2048 个字符 |
请求示例
示例里的 ID、幂等键等换成实际值。
bash
curl -sS -X POST 'https://open.cli.im/api/v2/rpc/staticQrcodes/create' \
-H "Authorization: Bearer ${CAOLIAO_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
"idempotency_key": "static-wifi-001",
"type": "text",
"content": "访客 Wi-Fi:Guest,密码见前台"
}'响应
成功时 HTTP 状态码为 200,顶层 code 为 0,结果在 data 里。失败时的返回见错误码与调用额度和业务错误码。
| 字段 | 类型 | 一定返回 | 说明 |
|---|---|---|---|
data.static_qrcode_id | string | 是 | 静态码 ID |
data.type | string | 是 | text 文本;url 网址。可选值:text、url |
data.content | string | 是 | 编码进二维码的内容 |
data.qrcode_image_url | string | 是 | 二维码图片地址,带时效签名;过期后可用同样的 content 重新生成 |
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 | 否 | 建议的下一步 |
响应示例
json
{
"code": 0,
"message": "ok",
"data": {
"static_qrcode_id": "8800123",
"type": "text",
"content": "访客 Wi-Fi:Guest,密码见前台",
"qrcode_image_url": "https://qr.api.cli.im/newqr/create?data=EXAMPLE&sign=EXAMPLE",
"status": "succeeded",
"errors": [],
"warnings": []
}
}常见错误
PERMISSION_DENIED、ACCESS_LEVEL_READ_ONLY、quota_exceeded、IDEMPOTENCY_CONFLICT、IDEMPOTENCY_IN_PROGRESS、IDEMPOTENCY_OUTCOME_UNKNOWN、URL_BLOCKED、AI_ORIGIN_MARK_FAILED。含义和处理方式见业务错误码。
本页由 openapi.json 生成。全部接口见接口清单。