Разработчици

POST/tcr/v2/brand/nonBlocking

Регистриране на марка за съобщения

Регистрирайте бизнес идентичност, собственост на акаунта, подавайте изрични sandbox заявки и съгласувайте валидацията и таксите.

На тази страница
  1. Регистрирайте бизнеса зад вашите съобщения
  2. Започнете с изрична sandbox заявка
  3. Полета за бизнеса и контакта
  4. Поддържайте стабилен ключ за идемпотентност
  5. Прочетете марката и нейния статус
  6. Продукционни такси
  7. Обработвайте грешките, без да дублирате марката

Регистрирайте бизнеса зад вашите съобщения

Марката за съобщения идентифицира бизнеса, който изпраща US 10DLC съобщения. Регистрирайте марката, преди да изберете случай на употреба за кампания. Използвайте юридическите данни на бизнеса и лице за контакт, което може да завърши всяка изисквана валидация. Върнатият идентификатор на марка сам по себе си не е одобрение за изпращане на съобщения.

Използвайте този текущ маршрут, собственост на акаунта, през HTTPS с активиран API акаунт и неговия разрешен IP адрес на източника. Не подавайте user_id, username или идентификатор на собственик на друг клиент. MultiTEL записва собствеността от удостоверения акаунт.

Започнете с изрична sandbox заявка

Порталът по подразбиране задава sandbox като стойност на полето mode във формуляра си; директната API заявка трябва изрично да включва JSON булевата стойност mock: true, когато възнамерявате да създадете mock марка. Пропускането на този флаг не е гаранция за sandbox и може да създаде платима продукционна регистрация. Полето 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 знака, и телефонен номер в международен формат с +код на държава, до 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 адрес и стойности на етикети, когато е приложимо. Те не установяват собственост върху акаунта и не заместват проверките на самоличността.
mockJSON булева стойност. Използвайте true само за целенасочения mock работен процес; използвайте false за изрично прегледана продукционна регистрация. Не изпращайте низа "false" като заместител на JSON булева стойност.

Едноличните търговци се поддържат за регистрации в САЩ или Канада и се нуждаят от OTP верификация, преди да станат допустими за кампания. Публичните компании може да изискват стъпка за валидация на бизнес контакт. GOVERNMENT е за правителствени субекти, базирани в САЩ; потвърдете правилната категория субект за другите организации. Следвайте изискванията за конкретния тип субект, както и върнатите грешки от валидацията.

Поддържайте стабилен ключ за идемпотентност

Генерирайте един Idempotency-Key за тази планирана регистрация. Той трябва да съдържа 1–128 печатаеми ASCII знака без интервали. Използвайте повторно същия ключ само със същия HTTP метод, път, низ на заявката и точно същите байтове на тялото на заявката. Преформатирането на JSON, дори без промяна на значението му, променя отпечатъка на заявката.

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

Запазете brand.json непроменен, докато разрешавате тази заявка. Кеширан отговор 500 или 502 може да възпроизведе първоначалната грешка, вместо да повтори регистрацията. Запазете всички върнати brandId, requestId и заглавки за корелация; съгласувайте съществуващата марка, преди да започнете различна заявка.

Прочетете марката и нейния статус

Този API използва HTTP кодове за състояние и директно JSON тяло, а не обвивката status/response на v3. Успешната регистрация връща обект на марка, включващ brandId. Съхранете този идентификатор и проверете върнатия статус на валидация или идентичност. Допълнителните полета зависят от субекта и състоянието на регистрацията.

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

Четете само марка, принадлежаща на вашия акаунт. Код 404 може да означава, че марката не е достъпна за този акаунт. Завършете всяка изисквана валидация, след което използвайте квалификация на марката за намиране на наличните ѝ случаи на употреба за кампания. Не може да се приема, че mock ресурсите са допустими за продукционно изпращане.

Продукционни такси

Текущо конфигурирани такси за регистрация на марка
РегистрацияТакса
Стандартна организация$5.00
Едноличен търговец$4.45
Mock маркаБез дебитиране за регистрация на марка в mock работния процес

Тези цени на дребно бяха проверени спрямо текущата конфигурация на портала на 24 октомври 2026 г. Потвърдете актуалната такса в портала преди продукционна регистрация. Таксите за кампании, допълнителната проверка и използването на съобщения са отделни. Продукционната регистрация проверява разрешението за покупка и наличното финансиране преди подаването; успешното създаване в регистъра и локалното фактуриране са отделни стъпки на обработка, затова запазете идентификатора на ресурса и съгласувайте транзакциите, ако възникне грешка или проблем с фактурирането.

Промяната на mock марка в продукционна е отделно потвърждаван работен процес и може да създаде нова продукционна идентичност и такса. Не приемайте, че редактирането на mock на false в по-късна заявка преобразува съществуващата марка.

Обработвайте грешките, без да дублирате марката

Неуспешни регистрации
HTTP резултатКакво да проверите
400Прочетете грешките по полета. Грешките от валидацията на регистъра могат да бъдат масив от обекти code/description. Локалната валидация на ключа за идемпотентност също може да върне 400.
401, 403 или 404Проверете API идентификационните данни, разрешения IP адрес на източника за API акаунта, клиентските разрешения и собствеността. Отговорът на регистъра също може да носи собствена грешка за оторизация.
402Прегледайте финансирането и разрешението за покупка. Не третирайте нефинансирана продукционна заявка като sandbox тест.
409Запазете същия ключ и непроменената заявка, докато изчаквате заявка в процес на обработка. Конфликт от променено тяло/ключ или невъзстановим предишен отговор първо изисква съгласуване.
429 или отговор за недостъпен ограничителСпазвайте Retry-After, когато е наличен. Повторете същата планирана заявка и ключ, след като ограничението отпадне.
500 или 502Отдалечената операция може да е била приета. Грешка при локалната обработка може да включва requestId. Запазете го и проверете съществуващия ресурс; не приемайте, че е необходима заместваща регистрация.