GET /v1/mail/services/{mailServiceId}/deliverability
SPF, DKIM and DMARC state for a domain that already has email.
المصادقة
أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (bearer token). يجب أن يحمل المفتاح إذن mail.view؛ والمفتاح الذي لا يملكه يُرفض بالرمز 403 وليس 404.
لا يقبل هذا الطرف أي معرف للمؤسسة. يحدد مفتاحك بالفعل المؤسسة التي ينتمي إليها، وتكون الاستجابة محصورة في نطاقها.
جربه الآن
استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.
curl -X GET https://api.zinndigital.com/v1/mail/services/{mailServiceId}/deliverability \
-H "Authorization: Bearer zdk_live_…"هل سجلت الدخول؟ تقوم وحدة تحكم واجهة برمجة التطبيقات في لوحة التحكم الخاصة بك بربط معرف مؤسستك الحقيقي ومفتاحك الخاص، وتنفذ الطلب مقابل واجهة برمجة التطبيقات المباشرة لتتمكن من رؤية الاستجابة الفعلية. افتح هذه النهاية الطرفية في وحدة تحكم API
التفاصيل
Whether this domain's mail is set up to be delivered - the question a customer asks when their messages land in spam. ⛔ A different question from /preflight, which asks what setting mail up here would destroy; both read the same underlying report so a preview and the fix cannot disagree. fixable is false when the apex MX belongs to somebody else or the zone cannot be read, because a one-click apply would then either destroy working mail or write blind. Requires mail.view.
المعلمات
| الاسم | النوع | مطلوب | ما هو هذا |
|---|---|---|---|
mailServiceId (path) | Uuid | نعم | Email service ID (UUIDv7). |
الاستجابة
| الاسم | النوع | مطلوب | ما هو هذا |
|---|---|---|---|
domain | string | نعم | — |
healthy | boolean | نعم | All three mechanisms present and ours - nothing to publish. |
spf_ok | boolean | نعم | — |
dkim_ok | boolean | نعم | — |
dmarc_ok | boolean | نعم | — |
fixable | boolean | نعم | Whether a one-click apply is offered. False over a foreign apex MX or an unreadable zone - the panel shows the reason instead of a button. |
needs_confirmation | boolean | نعم | True when applying would replace published records, so confirm is required. |
existing_apex_mx | string[] | نعم | — |
foreign_mx | string[] | نعم | Apex MX targets that are not ours - the reason a fix is refused. |
foreign_spf_includes | string[] | نعم | — |
would_delete | string[] | نعم | Records an apply would remove or replace, as NAME TYPE VALUE. Listed verbatim rather than counted: a customer must not be able to destroy mail records without seeing which ones… |
zone_unreadable | boolean | نعم | — |
reason | string | نعم | Customer-grade English. Never a driver message. |
warnings | string[] | نعم | — |
live_mx | string[] | نعم | The domain's MX hosts as PUBLIC DNS answers them right now (W43-09) - not our record of the zone. Empty when the domain publishes no MX, or when it could not be read (see… |
mx_readable | boolean | نعم | False when the public MX lookup failed. A failed lookup is never read as "action needed". |
mx_ok | boolean | نعم | Every live MX host is one this preset publishes, and there is at least one. |
action_needed | boolean | نعم | The customer's OWN DNS must change: we cannot publish to this zone and its live MX does not point where this preset sends mail. The panel then lists required_records with copy… |
required_records | object[] | نعم | The exact records to publish, as our preset would write them into a zone we host. |
الأخطاء التي يمكن أن تُرجعها نقطة النهاية هذه
401 · 403 · 404 · 429