身份验证
请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限,因此请为您的密钥赋予所需的最小权限,并通过检查响应来确认,而不是盲目假设。
此端点不需要组织 ID。您的密钥已用于识别其所属的组织,且响应范围也仅限于该组织。
免费试用
将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/mail-log \
-H "Authorization: Bearer zdk_live_…"已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
Paginated by the vendor, so `has_more` is its own answer rather than arithmetic on `total`. An empty page for a site with no mail is a normal state, not a failure. ⛔ Requires **`sites.panel_access`**, not `sites.view` — unlike every other read on this panel. Sender, recipient and subject lines are the customer's correspondence, the same class of data as their files and their database, and `sites.panel_access` is the key that already gates both. A principal holding only `sites.view` gets a 404.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
siteId (path) | Uuid | 是 | Site ID (UUIDv7). |
period (query) | string<hourly, daily, weekly, monthly> | 否 | How far back to look, in the vendor's own four buckets. |
direction (query) | string<incoming, outgoing> | 否 | ⛔ One direction at a time — the vendor has no "both", so a client showing a combined view must make two calls and say which is which. |
search (query) | string | 否 | Free-text match on sender, recipient or subject. |
page (query) | integer | 否 | — |
page_size (query) | integer | 否 | — |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
data | SiteMailLogEntry[] | 是 | — |
total | integer | 是 | — |
page | integer | 是 | — |
page_size | integer | 是 | — |
has_more | boolean | 是 | The vendor's own flag, not arithmetic on `total`. |
period | string | 是 | — |
direction | string | 是 | — |
periods | string[] | 是 | — |
directions | string[] | 是 | — |
此端点可能返回的错误
401 · 403 · 404 · 422 · 429 · 503