hosting
GET /v1/sites/{siteId}/mail-log
Messages the site's mail sent or received.
Упълномощаване
Изпратете API ключ като носител (bearer token). Тази точка за достъп не указва конкретно разрешение в спецификацията, затова дайте на ключа си най-малкото необходимо и проверете отговора, вместо да правите предположения.
Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/mail-log \
-H "Authorization: Bearer zdk_live_…"Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в 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[] | Да | — |
Грешки, които този крайpoint може да върне
401 · 403 · 404 · 422 · 429 · 503