Skip to content

批量模板列表

分页获取组织下的批量模板(占位码)列表。拿到占位码 coding 后可继续调 批量模板结构模板下子码列表

请求示例

python
import requests

url = "https://open.cli.im/api/v2/rpc/templates/list"
data = {"page_size": 20}
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/templates/list' \
  -H 'Authorization: Bearer <你的API Key>' \
  -H 'Content-Type: application/json' \
  -d '{"page_size": 20}'

请求参数

参数类型必填说明
start_timestring起始时间(ISO 8601),按创建时间过滤
end_timestring结束时间(ISO 8601)
page_tokenstring上一页返回的 next_page_token;首页不传
page_sizeinteger每页条数,默认 20,上限 100

完整返回示例

json
{
  "code": 0,
  "message": "ok",
  "data": {
    "list": [
      { "tpl_id": 88001, "name": "设备档案", "coding": "tA9kQ2f" },
      { "tpl_id": 88002, "name": "消防器材档案", "coding": "tB3mV7x" }
    ],
    "next_page_token": null,
    "total": 2
  }
}

响应结构

路径类型说明
data.list[].tpl_idinteger模板 ID
data.list[].namestring模板名称
data.list[].codingstring占位码 coding,模板相关接口的 template 入参
data.next_page_tokenstring|null下一页游标;为 null 表示已到最后一页
data.totalinteger满足条件的总条数

错误响应

错误响应为 {"code": 400, "message": "…", "data": {}} 形态,具体错误码定义见:错误码说明