Програмери

POST/tcr/v2/brand/nonBlocking

Региструјте бренд за слање порука

Региструјте пословни идентитет у власништву налога, нека sandbox захтеви буду експлицитни и ускладите валидацију и накнаде.

На овој страници
  1. Региструјте предузеће које стоји иза ваших порука
  2. Почните са експлицитним sandbox захтевом
  3. Поља предузећа и контакта
  4. Задржите стабилан кључ идемпотентности
  5. Прочитајте бренд и његов статус
  6. Продукционе накнаде
  7. Обрадите грешке без дуплирања бренда

Региструјте предузеће које стоји иза ваших порука

Бренд за слање порука идентификује предузеће које шаље 10DLC поруке у САД. Региструјте бренд пре него што изаберете случај употребе кампање. Користите правне податке предузећа и контакт особу која може да заврши сваку потребну валидацију. Враћени ID бренда сам по себи није одобрење за слање порука.

Користите ову тренутну руту у власништву налога преко HTTPS-а са омогућеним API налогом и његовом дозвољеном изворном IP адресом. Не шаљите user_id, username нити идентификатор власника другог корисника. MultiTEL бележи власништво на основу аутентификованог налога.

Почните са експлицитним sandbox захтевом

Портал подразумевано поставља поље mode свог обрасца на sandbox; директан 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Стварна адреса предузећа. Користите двословни код земље и актуелни код 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 тело, уместо v3 омотача status/response. Успешна регистрација враћа објекат бренда који садржи 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. Потврдите тренутну накнаду на порталу пре продукционе регистрације. Накнаде за кампање, додатна провера и коришћење порука наплаћују се засебно. Продукциона регистрација проверава дозволу за куповину и расположива средства пре слања; успешно креирање у регистру и локална наплата су засебни кораци обраде, па сачувајте ID ресурса и ускладите трансакције ако дође до грешке или проблема са наплатом.

Претварање mock бренда у продукциони је засебно потврђен ток рада и може да направи нови продукциони идентитет и наплату. Не претпостављајте да измена mock у false у каснијем захтеву конвертује постојећи бренд.

Обрадите грешке без дуплирања бренда

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