跳转到内容
simail文档v0

API 参考

事件

GET /v0/events、按邮箱拉取事件,以及 WebSocket 端点的参数、响应和错误。

docs.simail.ai/zh/api/events

载荷和类型见事件类型。如何可靠地拉取见拉取事件。

GET/v0/events

权限 event_read。

查询参数说明
after游标,来自 next_cursor;省略则从仍保留的最旧事件开始
types逗号分隔的事件类型
inbox_ids逗号分隔的邮箱 ID,须在你的作用域内
limit1–200,默认 50

200 OK:{ "count", "limit", "events": [ … ], "next_cursor" }。

状态code何时
400invalid_request游标属于另一把 key 的作用域、另一个组织或另一组过滤条件
403missing_permission没有 event_read
410gone游标早于 30 天保留期
GET/v0/inboxes/{inbox_id}/events

权限 event_read。参数(除了 inbox_ids)和响应都一样,只针对一个邮箱。

GETwss://api.simail.ai/v0/ws

权限 event_read。升级为 WebSocket。见实时推送。

关闭码含义
1000正常关闭,包括连接满 1 小时的寿命;请重连
4401key 被吊销或收紧,或组织被暂停;不要用这把 key 重连