Campaigns
GET /v1/campaigns/esp
The organisation's own e-mail provider account.
احراز هویت
یک کلید API را به عنوان یک توکن برbearer ارسال کنید. این نقطه پایانی مجوز خاصی را در مشخصات خود ذکر نمیکند، بنابراین به جای فرض کردن، حداقل نیازهای کلید خود را بدهید و پاسخ را بررسی کنید.
جایی که شناسه سازمان شما قرار میگیرد
این نقطه پایانی org_id را به عنوان یک پارامتر پرسوجو میپذیرد. آن را رها کنید تا فراخوانی کل زیردرخت اجارهای شما را پوشش دهد؛ آن را ارسال کنید تا فراخوانی به یک سازمان محدود شود.
شناسه سازمان شما در صفحه کلیدهای API در داشبوردتان، در کنار خود کلید قرار دارد. این شناسه در تمام درخواستهایی که ارسال میکنید یکسان است.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
curl -X GET https://api.zinndigital.com/v1/campaigns/esp \
-H "Authorization: Bearer zdk_live_…"وارد شدهاید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی API زنده اجرا میکند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید
جزئیات
Never returns the API key or its Vault path — only the state of the connection and its lifetime delivery counters.
پارامترها
| نام | نوع | الزامی | چیست |
|---|---|---|---|
org_id (query) | Uuid | خیر | The organization this call acts on. Optional for a caller with exactly one direct membership; **required** for anyone with more than one — which is every reseller and every agen… |
پاسخ
| نام | نوع | الزامی | چیست |
|---|---|---|---|
connected | boolean | بله | — |
id | string | خیر | — |
provider | string | بله | — |
status | string<not_connected, unverified, verified, rejected> | بله | — |
from_address | string | خیر | — |
from_local_part | string | خیر | — |
from_display_name | string | خیر | — |
sending_domain | string | خیر | — |
reply_to | string | خیر | — |
verified_domains | EspVerifiedDomain[] | خیر | — |
last_verified_at | string | خیر | — |
last_error | string | خیر | — |
stats | CampaignDeliveryCounts | خیر | ⛔ `sent` is NOT `delivered`. `sent` means a provider accepted the hand-off; `delivered` means the receiving server accepted it, which arrives later by webhook. A screen showing… |
خطاهایی که این نقطه پایانی میتواند برگرداند
401 · 403