搜索官方模板库
搜索官方模板库:keyword 匹配名称或描述,category_id 限定分类及其子分类,两者至少提供一个。page_size 默认 20、最大 50;模板库 ID 不能当作账号内的母码 ID 使用。
请求
text
POST https://open.cli.im/api/v2/rpc/gallery/list| 项目 | 要求 |
|---|---|
| 最低权限 | 只读,见权限档位 |
| 需要的 scope | templates.read |
| 组织 Key | 不能调用,返回 403 credential_type_not_allowed,见历史组织 Key |
请求参数
请求体为 JSON。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
category_id | string | 否 | 分类 ID,取自 gallery/categories,包含其子分类。与 keyword 至少传一个 |
keyword | string | 否 | 搜索关键词,匹配模板名称和简介,最长 100 字。与 category_id 至少传一个。最长 100 个字符 |
page | integer | 否 | 页码,从 1 开始。默认 1。范围 1–10000 |
page_size | integer | 否 | 每页条数。默认 20。范围 1–50 |
请求示例
示例里的 ID、幂等键等换成实际值。
bash
curl -sS -X POST 'https://open.cli.im/api/v2/rpc/gallery/list' \
-H "Authorization: Bearer ${CAOLIAO_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
"keyword": "设备巡检",
"page": 1,
"page_size": 20
}'响应
成功时 HTTP 状态码为 200,顶层 code 为 0,结果在 data 里。失败时的返回见错误码与调用额度和业务错误码。
| 字段 | 类型 | 一定返回 | 说明 |
|---|---|---|---|
data.list | object[] | 是 | 官方模板摘要 |
data.list[].gallery_template_id | string | 是 | 官方模板 ID |
data.list[].package_id | string | 是 | 模板安装包 ID |
data.list[].name | string | 是 | 模板名称 |
data.list[].description | string | 是 | 模板简介 |
data.list[].src_subtype | integer | 是 | 模板子类型编号 |
data.list[].installation_mode | integer | 是 | 安装方式编号 |
data.list[].form_count | integer | 是 | 模板包含的表单数 |
data.list[].state_count | integer | 是 | 模板包含的状态数 |
data.list[].supports_single | boolean | 是 | 是否支持生成单个码 |
data.pagination | object | 是 | 分页信息 |
data.pagination.page | integer | 是 | 当前页码,从 1 开始 |
data.pagination.page_size | integer | 是 | 每页条数 |
data.pagination.total | integer | 是 | 符合条件的总条数 |
data.pagination.has_more | boolean | 是 | 是否还有下一页。为 true 时即使当前页为空也应继续翻页 |
响应示例
json
{
"code": 0,
"message": "ok",
"data": {
"list": [
{
"gallery_template_id": "30128",
"package_id": "88213",
"name": "设备巡检",
"description": "适用于设备日常巡检和点检记录。",
"src_subtype": 1,
"installation_mode": 3,
"form_count": 1,
"state_count": 0,
"supports_single": true
}
],
"pagination": {
"page": 1,
"page_size": 20,
"total": 1,
"has_more": false
}
}
}常见错误
GALLERY_CATEGORY_NOT_FOUND、GALLERY_QUERY_UNAVAILABLE。含义和处理方式见业务错误码。
本页由 openapi.json 生成。全部接口见接口清单。