Розробникам

DELETE/tcr/v2/brand/{brandId}

Припинення реєстрації бренду для обміну повідомленнями

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

На цій сторінці
  1. Виберіть порядок припинення реєстрації
  2. Перегляньте наслідки на порталі
  3. Підготуйтеся до безпосереднього видалення через API
  4. Видаліть перевірений бренд
  5. Перевірте припинення реєстрації та узгодьте часткові результати
  6. Перевірте решту нарахувань за обліковим записом

Виберіть порядок припинення реєстрації

Припиніть реєстрацію бренду для обміну повідомленнями, коли компанії вона більше не потрібна. Це припиняє використання наявної реєстрації; нова реєстрація натомість не створюється, орендовані телефонні номери не звільняються, а ідентифікаційні дані компанії не виправляються. Для виправлення скористайтеся інструкцією Оновлення бренду для обміну повідомленнями.

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

Варіанти припинення реєстрації бренду
Порядок дійЩо виконується
Портал: видалити брендПоказує пов’язані кампанії та призначені номери, вимагає ввести ідентифікатор бренду для підтвердження, а потім намагається виконати пов’язане очищення перед видаленням бренду. Результати попередніх кроків можуть зберегтися, якщо на пізнішому кроці станеться збій.
API: DELETE /tcr/v2/brand/{brandId}Надсилає запит на видалення лише цього бренду, що належить обліковому запису. Номери автоматично не від’єднуються, а кампанії бренду не деактивуються. Активна кампанія може перешкодити видаленню.

Перегляньте наслідки на порталі

Відкрийте сторінку реєстрації для обміну повідомленнями, знайдіть потрібний бренд і виберіть «Видалити бренд». Перегляньте кількість пов’язаних кампаній і призначених номерів. Точно введіть ідентифікатор бренду, щоб зробити остаточну дію доступною. Форма для клієнта доступна лише тоді, коли обліковий запис має дозвіл на керування реєстраціями.

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

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

Підготуйтеся до безпосереднього видалення через API

Використовуйте активований обліковий запис API через HTTPS з дозволеної вихідної IP-адреси. Бренд має належати цьому обліковому запису. Отримайте та збережіть його ідентифікатор і поточний стан, а потім перевірте його кампанії та призначення номерів. Від’єднайте відповідні номери та деактивуйте кампанії перед видаленням бренду. Не вважайте цей виклик DELETE каскадною операцією.

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

Видаліть перевірений бренд

Виконуйте наведену нижче команду лише для запланованого припинення реєстрації, перевіривши ідентифікатор бренду та завершивши попереднє очищення. Запит не має тіла у форматі 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/brand/$BRAND_ID"

Задокументований успішний результат — HTTP 204 без тіла відповіді. Не вимагайте об’єкта успішного результату у форматі JSON або застарілої оболонки v3 status/response. Відхилений результат із кодом поза діапазоном 2xx не позначає бренд як видалений через поточний механізм синхронізації API.

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

Перевірте припинення реєстрації та узгодьте часткові результати

Після операції перевірте списки брендів і кампаній на порталі та відповідні номери. Синхронізація успішного результату публічного API позначає окремий бренд як видалений локально; вона не видаляє інші ресурси кампаній і не скасовує призначення придбаних номерів. Статус у реєстрі, призначення в системі оператора та локальне відображення потрібно перевіряти окремо.

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

У разі HTTP 400 прочитайте докладну помилку реєстру, особливо відомості про обмеження через активну кампанію. У разі 401, 403 або 404 перевірте облікові дані, дозволену вихідну IP-адресу та належність бренду обліковому запису. У разі 429 дотримуйтеся вказівки Retry-After. Час очікування може сплинути, а код 500 або 502 може надійти вже після завершення зміни в зовнішній системі; перевірте наявну реєстрацію, перш ніж повторювати запит.

Перевірте решту нарахувань за обліковим записом

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