GET /v1/mail/services/{mailServiceId}/deliverability
SPF, DKIM and DMARC state for a domain that already has email.
احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز mail.view باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد میشود، نه 404.
این نقطه پایانی هیچ شناسه سازمانی را دریافت نمیکند. کلید شما در حال حاضر سازمان مربوطه را مشخص میکند و پاسخ در همان محدوده ارائه میشود.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
curl -X GET https://api.zinndigital.com/v1/mail/services/{mailServiceId}/deliverability \
-H "Authorization: Bearer zdk_live_…"وارد شدهاید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی API زنده اجرا میکند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول 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