Разработчикам

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 не инициирует немедленное списание средств за регистрацию бренда. Удаление бренда не освобождает арендованные телефонные номера, не приводит к возврату средств и не определяет окончательный баланс учётной записи. Проверьте на портале все действующие обязательства по кампаниям, плату за аренду номеров и использование услуг. Эта операция не является расчётом стоимости этих отдельных услуг.