API 参考
事件
GET /v0/events、按邮箱拉取事件,以及 WebSocket 端点的参数、响应和错误。
docs.simail.ai/zh/api/events
GET
/v0/events权限 event_read。
| 查询参数 | 说明 |
|---|---|
after | 游标,来自 next_cursor;省略则从仍保留的最旧事件开始 |
types | 逗号分隔的事件类型 |
inbox_ids | 逗号分隔的邮箱 ID,须在你的作用域内 |
limit | 1–200,默认 50 |
200 OK:{ "count", "limit", "events": [ … ], "next_cursor" }。
| 状态 | code | 何时 |
|---|---|---|
| 400 | invalid_request | 游标属于另一把 key 的作用域、另一个组织或另一组过滤条件 |
| 403 | missing_permission | 没有 event_read |
| 410 | gone | 游标早于 30 天保留期 |
GET
/v0/inboxes/{inbox_id}/events权限 event_read。参数(除了 inbox_ids)和响应都一样,只针对一个邮箱。
WebSocket
Section titled “WebSocket”GET
wss://api.simail.ai/v0/ws权限 event_read。升级为 WebSocket。见实时推送。
| 关闭码 | 含义 |
|---|---|
1000 | 正常关闭,包括连接满 1 小时的寿命;请重连 |
4401 | key 被吊销或收紧,或组织被暂停;不要用这把 key 重连 |