Campaigns
POST /v1/campaigns/{campaignId}/control
Pause, resume or cancel a running send.
احراز هویت
یک کلید API را به عنوان یک توکن برbearer ارسال کنید. این نقطه پایانی مجوز خاصی را در مشخصات خود ذکر نمیکند، بنابراین به جای فرض کردن، حداقل نیازهای کلید خود را بدهید و پاسخ را بررسی کنید.
جایی که شناسه سازمان شما قرار میگیرد
این نقطه پایانی org_id را به عنوان یک فیلد در بدنه JSON دریافت میکند.
شناسه سازمان شما در صفحه کلیدهای 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.
پارامترها
| نام | نوع | الزامی | چیست |
|---|---|---|---|
campaignId (path) | string | بله | — |
بدنه درخواست
| نام | نوع | الزامی | چیست |
|---|---|---|---|
action | string<pause, resume, cancel> | بله | — |
org_id | string | خیر | — |
پاسخ
| نام | نوع | الزامی | چیست |
|---|---|---|---|
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