分页
列表端点以分页方式返回数据。平台历史上形成了两种分页方案;具体方案在交互式参考的端点说明中注明。
方案 1 — 偏移量与 X-Total-Count
经典的偏移量分页。请求接受查询参数 limit(每页大小)和 offset(跳过的记录数):
curl -H "Authorization: Bearer mbp_YOUR_TOKEN" "https://your-domain/api/bots/BOT_ID/subscribers?limit=50&offset=100"
总记录数通过响应头 X-Total-Count 返回。根据它计算页数:每次将 offset 增加 limit,直到 offset 大于等于 X-Total-Count。响应体是当前页的元素数组。
方案 2 — before 游标与 has_more
适用于按时间排序的信息流(例如对话消息)的游标分页。请求接受 limit 和可选游标 before——最后一个已获取元素的标识符或标记:
curl -H "Authorization: Bearer mbp_YOUR_TOKEN" "https://your-domain/api/bots/BOT_ID/users/USER_ID/dialog?limit=50&before=CURSOR"
响应包含一页元素和 has_more 标志。当 has_more 为 true 时,继续请求并将最后获取元素的游标传入 before。当 has_more 变为 false 时,说明已到最后一页。
如何选择方案
你无需选择——方案由端点决定。字典类列表通常使用偏移量和 X-Total-Count;时间序列信息流使用 before 游标和 has_more。请始终参考参考文档中的端点说明。