Skip to main content

Объект кампании, блокеры и предупреждения

Объект кампании

Приходит в POST /v1/campaigns, GET /v1/campaigns/{id}, POST …/launch, POST …/pause, POST …/resume, POST …/cancel. Как читать ответ на создание
  1. statusrunning (набор идёт), scheduled (окно в будущем) или draft (не начался). Ничто другое в теле не означает «запустилось».
  2. Непустой blockers при созданииstatus: "draft". Кампания и отчёт по загрузке сохраняются. Исправьте то, что названо в блокерах, и вызовите POST /v1/campaigns/{id}/launch.
  3. import равен null, если planned_calls был пуст; в blockers тогда лежит no_pending_contacts (если кампания не открыта к добавлению звонков).
  4. warnings ничего не блокируют. Два из них есть практически у каждой кампании: starts_immediately (нет будущего starts_at) и frequency_policy_active (действующие ограничения частоты на номер) — последний заменяется на frequency_limits_disabled, когда эти ограничения выключены.
  5. timezone_sourcerequest, если зону назвали вы, и organization, если она унаследована. Читается одинаково на всех путях: ответ на создание, GET /v1/campaigns/{id} и список согласованы.

Блокеры и предупреждения

blockers и warnings считает та же проверка запуска, что работает в кабинете. Каждый элемент — объект с машиночитаемым code; у большинства блокеров есть ещё field — поле запроса, о котором идёт речь. Форма зависит от пути — читайте только то, что гарантировано:
Как читать blockers в GET /v1/campaigns/{id} и launch-check. На путях чтения список отвечает на вопрос «что сказала бы проверка запуска прямо сейчас», причём считается без подписи и независимо от текущего статуса. Следствия: у работающей кампании всегда виден attestation_required (подпись даётся на каждый запуск, а не хранится как состояние), а у работающей кампании с опустевшей очередью — no_pending_contacts. То есть на путях чтения непустой blockers не означает status: "draft" — для этого есть status, а blockers читайте как список того, что должен будет пройти будущий launch / resume.
Коды блокеров Коды предупреждений