hosting
GET /v1/sites/{siteId}/mail-log
Messages the site's mail sent or received.
احراز هویت
یک کلید API را به عنوان یک توکن برbearer ارسال کنید. این نقطه پایانی مجوز خاصی را در مشخصات خود ذکر نمیکند، بنابراین به جای فرض کردن، حداقل نیازهای کلید خود را بدهید و پاسخ را بررسی کنید.
این نقطه پایانی هیچ شناسه سازمانی را دریافت نمیکند. کلید شما در حال حاضر سازمان مربوطه را مشخص میکند و پاسخ در همان محدوده ارائه میشود.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
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