分区列表
获取组织下的分区(project)名单。分区是活码与记录的归属维度:
- 统计时可按分区分组——按指标出数 的
group_by: "project" - 检索时可按分区过滤——
scope/filters的project_ids
请求示例
python
import requests
url = "https://open.cli.im/api/v2/rpc/projects/list"
data = {}
headers = {
"Authorization": "Bearer <你的API Key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=data, headers=headers)
print(response.text)bash
curl -X POST 'https://open.cli.im/api/v2/rpc/projects/list' \
-H 'Authorization: Bearer <你的API Key>' \
-H 'Content-Type: application/json' \
-d '{}'请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
page_size | integer | 否 | 最多返回条数,默认 100,上限 100 |
完整返回示例
json
{
"code": 0,
"message": "ok",
"data": {
"list": [
{ "project_id": "1101", "name": "初始分区", "parent_id": null },
{ "project_id": "1104", "name": "消防管理", "parent_id": null },
{ "project_id": "1105", "name": "消防管理-东区", "parent_id": "1104" }
],
"total": 3
}
}响应结构
| 路径 | 类型 | 说明 |
|---|---|---|
data.list[].project_id | string | 分区 ID,统计分组与范围过滤的入参 |
data.list[].name | string | 分区名称 |
data.list[].parent_id | string|null | 父分区 ID;顶级分区为 null。分区支持层级结构 |
data.total | integer | 返回条数 |
错误响应
错误响应为 {"code": 400, "message": "…", "data": {}} 形态,具体错误码定义见:错误码说明。