Campaigns
POST /v1/campaigns/{campaignId}/control
Pause, resume or cancel a running send.
Аутентификация
API кілтін bearer токені ретінде жіберіңіз. Бұл соңғы нүкте сипаттамада арнайы рұқсатты көрсетпейді, сондықтан болжағаннан гөрі кілтіңізге қажетті ең аз рұқсатты беріп, жауапты тексеріңіз.
Ұйымыңыздың идентификаторы орналасатын жер
Бұл соңғы нүкте JSON корпусында өріс ретінде org_id қабылдайды.
Сіздің ұйым идентификаторыңыз басқару панеліндегі API кілттері экранында, кілттің өзінің жанында орналасқан. Бұл сіз жасайтын әрбір шақырудағы бірдей идентификатор.
Әрекет етіп көру
Бұрыштық жақшалардағы кез келген нәрсені өз мәндеріңізбен, ал кілт орналастырушысын басқару тақтасынан алынған кілтпен алмастырыңыз.
curl -X POST https://api.zinndigital.com/v1/campaigns/{campaignId}/control \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "action": <string<pause, resume, cancel>> }'Жүйеге кіргенсіз бе? Бақылау тақтасындағы API консолі ұйымыңыздың нақты идентификаторы мен жеке кілтіңізді автоматты түрде толтырады да, нақты жауапты көре алуыңыз үшін сұрауды тікелей жұмыс істеп тұрған API арқылы орындайды. Бұл соңғы нүктені API консолінде ашыңыз
Мәліметтер
The decision is written to the database first and signalled second, so a worker that restarted and never saw the signal still stops on its next batch.
Параметрлер
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
campaignId (path) | string | Иә | — |
Сұрау денесі
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
action | string<pause, resume, cancel> | Иә | — |
org_id | string | Жоқ | — |
Жауап
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
id | string | Иә | — |
org_id | string | Иә | — |
name | string | Иә | — |
template_id | string | Иә | — |
segment_id | string | Жоқ | — |
purpose | string<marketing, transactional> | Иә | — |
channels | string[] | Иә | — |
status | string<draft, scheduled, sending, paused, sent, cancelled, failed> | Иә | — |
scheduled_for | string | Жоқ | — |
include_not_in_good_standing | boolean | Жоқ | — |
total_recipients | integer | Иә | — |
skipped | CampaignSkipCounts | Иә | ⛔ Every skip counted separately and never silent, and **every one is present even when it is zero**. "4,127 recipients, 312 skipped — not in good standing" is rendered from thes… |
delivery | 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… |
last_error | string | Жоқ | — |
created_at | string | Иә | — |
started_at | string | Жоқ | — |
finished_at | string | Жоқ | — |
signal_delivered | boolean | Жоқ | ⛔ Reported honestly. `false` means the decision is recorded and the running workflow was not reachable — it will still stop on its next batch, but that is a real difference an o… |
Бұл соңғы нүкте қайтара алатын қателер
401 · 403 · 404 · 422