Розробникам

POST/tcr/v2/brand/nonBlocking

Зареєструйте бренд для обміну повідомленнями

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

На цій сторінці
  1. Зареєструйте бізнес, що стоїть за вашими повідомленнями
  2. Почніть із явного запиту до пісочниці
  3. Поля бізнесу та контактів
  4. Зберігайте стабільний ключ ідемпотентності
  5. Прочитайте бренд та його статус
  6. Тарифи бойового використання
  7. Обробляйте помилки без дублювання бренду

Зареєструйте бізнес, що стоїть за вашими повідомленнями

Бренд повідомлень ідентифікує компанію, яка надсилає повідомлення US 10DLC. Зареєструйте бренд, перш ніж обирати варіант використання кампанії. Використовуйте юридичні дані компанії та контактну особу, яка зможе пройти потрібну перевірку. Повернутий ідентифікатор бренда сам по собі не є дозволом на надсилання повідомлень.

Використовуйте цей актуальний маршрут, що належить обліковому запису, через HTTPS з увімкненим обліковим записом API та його дозволеною IP-адресою джерела. Не надсилайте user_id, username або інший ідентифікатор власника іншого клієнта. MultiTEL фіксує власність за автентифікованим обліковим записом.

Почніть із явного запиту до пісочниці

У формі порталу поле mode за замовчуванням установлено в режим пісочниці; прямий запит API має явно містити логічне значення JSON mock: true, якщо ви маєте намір створити тестовий бренд. Пропуск цього прапорця не гарантує пісочницю та може створити оплатну бойову реєстрацію. Поле mode порталу не замінює поле mock API.

Підготуйте локальний файл brand.json, використовуючи поля нижче. Замініть заповнювачі відповідними тестовими даними й актуальними кодами з каталогів. У цьому прикладі — приватний прибутковий бізнес; інші типи сутностей мають інші вимоги.

{
  "entityType": "PRIVATE_PROFIT",
  "displayName": "Example business",
  "companyName": "Example legal business name",
  "ein": "YOUR_TAX_ID",
  "einIssuingCountry": "US",
  "phone": "+12025550123",
  "street": "123 Example Street",
  "city": "Example City",
  "state": "NY",
  "postalCode": "10001",
  "country": "US",
  "email": "contact@example.invalid",
  "brandRelationship": "BASIC_ACCOUNT",
  "vertical": "CURRENT_VERTICAL_CODE",
  "referenceId": "your-business-reference",
  "mock": true
}

Наведені вище компанія, адреса, телефон та ідентифікатор є заповнювачами, а не готовою до реєстрації бізнес-ідентичністю. Актуальні значення для entityType, vertical, country, state, brandRelationship та інших переліків дивіться в каталогах повідомлень.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --header 'Content-Type: application/json' \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  --data-binary @brand.json \
  'https://api.multitel.net/tcr/v2/brand/nonBlocking'

Поля бізнесу та контактів

Поля реєстрації бренду
ПоляЩо вказати
entityType, displayNameАктуальний код типу сутності та впізнавана назва бренду. Максимальна довжина становить 20 і 255 символів відповідно.
country, street, city, state, postalCodeФактична адреса компанії. Використовуйте дволітерний код країни та актуальний US-код state, коли це застосовно. Обмеження: street 255, city 100, state 20 і postalCode 10 символів.
email, phoneРобоча контактна адреса електронної пошти довжиною до 100 символів і номер телефону в міжнародному форматі +country-code довжиною до 20 символів. Зберігайте узгодженість даних компанії в межах реєстрації.
companyName, ein, einIssuingCountryДля організацій укажіть юридичну назву компанії та податковий ідентифікатор бізнесу. Країна видачі ідентифікатора — окреме дволітерне поле. Обмеження: companyName 255 і ein 21 символ. Одноосібний підприємець використовує поля особистого імені замість податкової ідентичності організації.
brandRelationship, verticalЗв’язок із бізнесом та його галузь з використанням актуальних кодів каталогів. Для організацій вони обов’язкові; для одноосібних підприємців правила відрізняються. Не замінюйте коди API перекладеними назвами для відображення.
firstName, lastName, mobilePhoneОбов’язково для одноосібного підприємця. Поля імені допускають до 100 символів кожне. Укажіть придатний мобільний номер для обов’язкової OTP-перевірки в міжнародному форматі.
stockSymbol, stockExchange, website, businessContactEmailПублічна компанія також потребує біржового символу/біржі, website й придатної контактної адреси електронної пошти компанії для додаткової перевірки. Обмеження: stockSymbol 10, website 255 і businessContactEmail 255 символів.
altBusinessIdType, altBusinessIdНеобов’язковий альтернативний ідентифікатор бізнесу. Указуйте його тип і значення разом. Використовуйте актуальний каталог типів; значення допускає до 50 символів.
referenceIdВаше бізнес-посилання довжиною до 50 символів. Додавайте його для реєстрації одноосібного підприємця відповідно до актуальних вимог для конкретної сутності. Це бізнес-метадані, а не ключ ідемпотентності запиту.
website, ipAddress, tagДодатковий вебсайт, метадані вихідної IP-адреси та значення тегів, коли це застосовно. Вони не встановлюють власність облікового запису й не замінюють перевірку ідентичності.
mockЛогічне значення JSON. Використовуйте true лише для навмисного тестового сценарію; використовуйте false для явно переглянутої бойової реєстрації. Не надсилайте рядок "false" замість логічного значення JSON.

Одноосібні підприємці підтримуються для реєстрацій US або Канади та потребують OTP-перевірки перед отриманням права на кампанії. Публічні компанії можуть потребувати етапу перевірки бізнес-контакту. GOVERNMENT призначено для урядових структур, розташованих у US; для інших організацій підтверджуйте правильну категорію сутності. Дотримуйтеся вимог для конкретної сутності, а також повернутих помилок перевірки.

Зберігайте стабільний ключ ідемпотентності

Створіть один Idempotency-Key для цієї навмисної реєстрації. Він має містити 1–128 друкованих символів ASCII без пробілів. Повторно використовуйте той самий ключ лише з тим самим методом HTTP, шляхом, рядком запиту й точними байтами тіла запиту. Переформатування JSON, навіть без зміни його значення, змінює відбиток запиту.

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

Не змінюйте brand.json під час вирішення цього запиту. Кешована помилка 500 або 502 може повторно відтворити вихідну помилку замість повторної спроби реєстрації. Зберігайте будь-які повернуті brandId, requestId та заголовки кореляції; звірте фактичний стан наявного бренду й усуньте розбіжності, перш ніж починати інший запит.

Прочитайте бренд та його статус

Цей API використовує коди стану HTTP і пряме тіло JSON замість обгортки v3 status/response. Успішна реєстрація повертає об’єкт бренда, включно з brandId. Збережіть цей ідентифікатор і перевірте повернутий статус перевірки або ідентичності. Додаткові поля залежать від сутності та стану реєстрації.

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

Читайте лише бренд, що належить вашому обліковому запису. Помилка 404 може означати, що бренд недоступний для цього облікового запису. Завершіть усі потрібні перевірки, а потім скористайтеся кваліфікацією бренду, щоб знайти доступні варіанти використання кампаній. Не можна вважати тестові ресурси придатними для бойового надсилання.

Тарифи бойового використання

Актуальні налаштовані тарифи реєстрації бренду
РеєстраціяТариф
Стандартна організація$5.00
Одноосібний підприємець$4.45
Тестовий брендБез списання за реєстрацію бренду в тестовому сценарії

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

Переведення тестового бренду в бойовий режим — це окремо підтверджуваний сценарій, який може створити нову бойову ідентичність і списання коштів. Не припускайте, що редагування mock на false у пізнішому запиті перетворює наявний бренд.

Обробляйте помилки без дублювання бренду

Помилки реєстрації
Результат HTTPЩо перевірити
400Прочитайте помилки полів. Помилки перевірки реєстру можуть бути масивом об’єктів code/description. Локальна перевірка ключа ідемпотентності також може повертати 400.
401, 403 або 404Перевірте облікові дані API, дозволену IP-адресу джерела облікового запису API, дозволи клієнта та власність. Відповідь реєстру також може містити власну помилку авторизації.
402Перевірте фінансування та дозвіл на купівлю. Не сприймайте нефінансований бойовий запит як тест пісочниці.
409Зберігайте той самий ключ і незмінний запит під час очікування запиту, що виконується. Конфлікт зміненого тіла/ключа або невідновлювана попередня відповідь спочатку потребують перевірки фактичного стану й усунення розбіжностей.
429 або відповідь про недоступність обмежувачаДотримуйтеся Retry-After, якщо він присутній. Повторіть той самий навмисний запит і ключ після зняття обмеження.
500 або 502Віддалену операцію, можливо, уже прийнято. Помилка локальної обробки може містити requestId. Збережіть його та перевірте наявний ресурс; не припускайте, що потрібна замінна реєстрація.