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, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в 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