Campaigns
GET /v1/campaigns/esp
The organisation's own e-mail provider account.
Doğrulama
API açarını bearer token kimi göndərin. Bu səhifə spresifikasiyada xüsusi icazə tələb etmir, buna görə də açarınıza ehtiyac duyduğu minimum səviyyədə icazə verin və güman etmək əvəzinə cavabı yoxlayın.
Təşkilatınızın identifikatorunun yerləşdiyi yer
Bu son nöqtə sorğu parametri kimi org_id qəbul edir. Onu buraxın və sorğu bütün kirayə alt ağacınızı əhatə etsin; sorğunu bir təşkilatla məhdudlaşdırmaq üçün onu göndərin.
Təşkilatınızın identifikatoru idarə panelinizdəki API açarları ekranında, açarın özünün yanında yerləşir. Bu, etdiyiniz hər bir sorğuda eyni identifikatordur.
Sınaqdan keçir
Bucaqlı mötərizələrdə olan hór şeyi öz qiymətlərinizlə, açar yertutucusunu isə idarə panelinizdən bir açarla əvəz edin.
curl -X GET https://api.zinndigital.com/v1/campaigns/esp \
-H "Authorization: Bearer zdk_live_…"Sistemə daxil olmusunuz? İdarə panelinizdəki API konsolu real təşkilatınızın identifikatorunu və öz açarınızı avtomatik doldurur, sorğunu canlı API-yə qarşı icra edir ki, siz faktiki cavabı görə biləsiniz. Bu son nöqtəni API konsolunda açın
Təfərrüatlar
Never returns the API key or its Vault path — only the state of the connection and its lifetime delivery counters.
Parametrlər
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
org_id (query) | Uuid | Xeyr | 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… |
Cavab
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
connected | boolean | Bəli | — |
id | string | Xeyr | — |
provider | string | Bəli | — |
status | string<not_connected, unverified, verified, rejected> | Bəli | — |
from_address | string | Xeyr | — |
from_local_part | string | Xeyr | — |
from_display_name | string | Xeyr | — |
sending_domain | string | Xeyr | — |
reply_to | string | Xeyr | — |
verified_domains | EspVerifiedDomain[] | Xeyr | — |
last_verified_at | string | Xeyr | — |
last_error | string | Xeyr | — |
stats | CampaignDeliveryCounts | Xeyr | ⛔ `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… |
Bu son nöqtənin qaytara biləcəyi xətalar
401 · 403