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

التفاصيل

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

GET /v1/sites/{siteId}/mail-log