Деактивація кампанії обміну повідомленнями

Деактивація наявної кампанії обміну повідомленнями

Використовуйте цей маршрут для припинення кампанії, що належить обліковому запису. Збережіть ідентифікатор кампанії для звіряння та історії. Для виправлення вмісту або оновлення тексту згоди скористайтеся дією Оновити кампанію обміну повідомленнями замість деактивації.

Пройдіть автентифікацію за допомогою ввімкненого облікового запису API через HTTPS з дозволеної вихідної IP-адреси. Спочатку отримайте дані кампанії та перевірте пов’язаний бренд і номери для надсилання. Деактивація змінює реєстрацію; вона не створює кампанію на заміну й не переносить номери до іншої кампанії.

curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"

Спочатку видаліть призначення відповідних номерів

Загальнодоступна операція DELETE для кампанії не від’єднує телефонні номери від оператора обміну повідомленнями й не видаляє їхнє локальне призначення. Виконайте процедуру видалення призначення номера кампанії для кожного відповідного номера, що належить обліковому запису, а потім перевірте його призначення. Видалення призначення не звільняє телефонний номер.

Ширша процедура порталу «Видалити бренд» виконує очищення його кампаній і номерів перед видаленням бренду. Не використовуйте цю дію, якщо плануєте зберегти бренд та інші його кампанії. У поточному звичайному редакторі кампаній немає окремої кнопки видалення кампанії, еквівалентної цьому прямому маршруту API.

Надішліть запланований запит на деактивацію

Перевіривши ідентифікатор кампанії та відповідні налаштування надсилання, надішліть DELETE без тіла JSON:

curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
  --request DELETE \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  "https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"

Задокументована успішна відповідь — HTTP 204 з порожнім тілом. Перевіряйте статус HTTP, а не очікуйте обгортку JSON status/response. Коли видалення прийнято, поточний сервіс локально позначає ресурс кампанії як видалений і такий, строк дії якого минув, а її запис у застарілій системі — як такий, строк дії якого минув. Каскадне видалення бренду не виконується.

Використовуйте один ключ ідемпотентності для цього запланованого запиту та збережіть точні метод, шлях, параметри запиту й байти тіла для повторного відтворення. Дублікат запиту, який ще обробляється, може повернути 409 із Retry-After; для завершених запитів може повторно повертатися збережений результат. Кешована помилка або розірване з’єднання не дають змоги встановити, чи реєстр уже виконав дію. Збережіть ідентифікатор кампанії та requestId, якщо його надано.

Перевірте і реєстрацію, і призначення

Після запиту перевірте на порталі поточний стан кампанії та відповідні номери. Після припинення API може зберігати локальні метадані належності, щоб ідентифікатор, який належить обліковому запису, усе ще можна було перевірити; не робіть висновку, що той самий ідентифікатор завжди має повертати локальну відповідь 404. Реєстр визначає статус, що повертається, або доступність запису припиненої кампанії.

Якщо номер залишається призначеним, узгодьте це наявне призначення. Не створюйте іншу кампанію лише для повторної спроби деактивації та не вважайте, що HTTP 204 доводить виконання очищення в оператора. Якщо після прийняття запиту реєстром локальна синхронізація завершується помилкою, API може повернути 500, хоча деактивація в зовнішній системі вже відбулася.

Результати деактивації
Результат	Наступний крок
204	Тіло відповіді не очікується. Перевірте стан кампанії та призначення номерів, якими керують окремо.
400	Прочитайте надане повідомлення про помилку валідації або стану реєстру. Перевірте точний ідентифікатор кампанії та її наявний стан.
401, 403, 404	Перевірте облікові дані API, дозволену вихідну IP-адресу та належність обліковому запису. Не підставляйте ідентифікатор іншого клієнта.
409, 429	Відрізняйте ідемпотентний запит, який ще виконується або конфліктує, від обмеження частоти запитів; дотримуйтеся Retry-After, якщо цей заголовок надано.
500, 502 або перевищення часу очікування	Збережіть відомості про запит, отримайте дані наявної кампанії та узгодьте їх перед повторним надсиланням.

Припинення та фінансові розрахунки за обліковим записом є окремими діями

Поточний сервіс DELETE не ініціює негайне списання плати за реєстрацію кампанії. Це не обіцяє повернення коштів, не скасовує наявного зобов’язання й не звільняє орендовані номери. Перевірте на порталі умови кампаній облікового запису та неоплачені рахунки. Оренда номерів і використання повідомлень обліковуються окремо від реєстрації кампанії.

Якщо після узгодження кампаній і призначень припиняється вся реєстрація компанії, перейдіть до припинення реєстрації бренду.