查询当前可用于新建的分区或目录
查询新建时可用的分区和目录:先传 kind=projects,再用返回的 project_id 查 kind=categories。只读,不创建目录;has_more=true 时继续翻页。
请求
text
POST https://open.cli.im/api/v2/rpc/qrcodes/listCreateTargets| 项目 | 要求 |
|---|---|
| 最低权限 | 只读,见权限档位 |
| 需要的 scope | templates.read |
| 组织 Key | 不能调用,返回 403 credential_type_not_allowed,见历史组织 Key |
相关调用流程:按模板批量建码。
请求参数
请求体为 JSON。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
kind | string | 否 | 查询类型:projects(默认)列出可以建码的分区;categories 列出某个分区下的目录。可选值:projects、categories。默认 "projects" |
project_id | integer | 否 | kind 为 categories 时要查询的分区 ID,取自 kind=projects 的结果;0 为默认分区。默认 0 |
page | integer | 否 | 页码,从 1 开始。默认 1。最小 1 |
page_size | integer | 否 | 每页条数。默认 20。范围 1–100 |
请求示例
示例里的 ID、幂等键等换成实际值。
bash
curl -sS -X POST 'https://open.cli.im/api/v2/rpc/qrcodes/listCreateTargets' \
-H "Authorization: Bearer ${CAOLIAO_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
"kind": "categories",
"project_id": 0,
"page": 1,
"page_size": 20
}'响应
成功时 HTTP 状态码为 200,顶层 code 为 0,结果在 data 里。失败时的返回见错误码与调用额度和业务错误码。
| 字段 | 类型 | 一定返回 | 说明 |
|---|---|---|---|
data.kind | string | 是 | 本次查询的类型。可选值:projects、categories |
data.items | object[] | 是 | 可用的分区或目录 |
data.items[].name | string | 是 | 名称 |
data.items[].project_id | integer | 是 | 分区 ID |
data.items[].category_id | integer | 否 | 目录 ID;kind 为 categories 时返回 |
data.items[].parent_id | integer | 否 | 上级目录 ID;kind 为 categories 时返回 |
data.page | integer | 是 | 当前页码,从 1 开始 |
data.page_size | integer | 是 | 每页条数 |
data.has_more | boolean | 是 | 是否还有下一页。为 true 时即使当前页为空也应继续翻页 |
响应示例
json
{
"code": 0,
"message": "ok",
"data": {
"kind": "categories",
"items": [
{
"category_id": 120045,
"name": "设备档案",
"parent_id": 0,
"project_id": 0
}
],
"page": 1,
"page_size": 20,
"has_more": false
}
}常见错误
PERMISSION_DENIED。含义和处理方式见业务错误码。
本页由 openapi.json 生成。全部接口见接口清单。