Vývojáři

POST/tcr/v2/brand/nonBlocking

Registrace značky pro zasílání zpráv

Zaregistrujte obchodní identitu vlastněnou účtem, udržujte požadavky na sandbox explicitní a sesouhlaste validaci a poplatky.

Na této stránce
  1. Zaregistrujte firmu stojící za vašimi zprávami
  2. Začněte explicitním požadavkem na sandbox
  3. Pole firmy a kontaktu
  4. Udržujte stabilní klíč idempotence
  5. Přečtěte značku a její stav
  6. Produkční poplatky
  7. Zpracujte chyby bez duplikování značky

Zaregistrujte firmu stojící za vašimi zprávami

Značka pro zasílání zpráv identifikuje firmu, která odesílá zprávy US 10DLC. Zaregistrujte značku před výběrem případu použití kampaně. Použijte právní údaje firmy a kontaktní osobu, která může dokončit jakoukoli požadovanou validaci. Vrácené ID značky samo o sobě není schválením k odesílání zpráv.

Použijte tuto aktuální trasu vlastněnou účtem přes HTTPS s povoleným účtem API a jeho povolenou zdrojovou IP adresou. Neodesílejte user_id, username ani identifikátor vlastníka jiného zákazníka. MultiTEL zaznamenává vlastnictví z autentizovaného účtu.

Začněte explicitním požadavkem na sandbox

Portál nastavuje pole mode svého formuláře ve výchozím stavu na sandbox; přímý požadavek API musí explicitně obsahovat JSON boolean mock: true, pokud zamýšlíte vytvořit mock značku. Vynechání tohoto příznaku není zárukou sandboxu a může vytvořit zpoplatněnou produkční registraci. Pole mode portálu nenahrazuje pole mock v API.

Připravte místní soubor brand.json s použitím níže uvedených polí. Nahraďte zástupné hodnoty vhodnými testovacími údaji a aktuálními kódy katalogu. Tento příklad je soukromá zisková firma; jiné typy subjektů mají odlišné požadavky.

{
  "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
}

Firma, adresa, telefon a identifikátor výše jsou zástupné hodnoty, nikoli obchodní identita připravená k registraci. Aktuální hodnoty pro entityType, vertical, country, state, brandRelationship a další výčty získáte z katalogů pro zasílání zpráv.

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'

Pole firmy a kontaktu

Pole registrace značky
PoleCo uvést
entityType, displayNameAktuální kód typu subjektu a rozpoznatelný název značky. Maximální délky jsou 20 a 255 znaků.
country, street, city, state, postalCodeSkutečná adresa firmy. Použijte dvoupísmenný kód země a tam, kde to platí, aktuální kód US state. Limity: street 255, city 100, state 20 a postalCode 10 znaků.
email, phoneFunkční kontaktní e-mail, nejvýše 100 znaků, a telefonní číslo v mezinárodním formátu +kód-země, nejvýše 20 znaků. Udržujte údaje o firmě v celé registraci konzistentní.
companyName, ein, einIssuingCountryU organizací uveďte právní název společnosti a daňový identifikátor firmy. Země vydání identifikátoru je samostatné dvoupísmenné pole. Limity: companyName 255 a ein 21 znaků. Živnostník používá místo daňové identity organizace pole s osobním jménem.
brandRelationship, verticalVztah k firmě a její odvětví pomocí aktuálních kódů katalogu. Organizace je vyžadují; pravidla pro živnostníky se liší. Nenahrazujte kódy API přeloženými zobrazovanými popisky.
firstName, lastName, mobilePhoneVyžadováno u živnostníka. Pole se jmény povolují každé nejvýše 100 znaků. Uveďte způsobilé mobilní číslo v mezinárodním formátu pro požadované ověření OTP.
stockSymbol, stockExchange, website, businessContactEmailVeřejně obchodovaná společnost potřebuje pro dodatečný validační proces také svůj burzovní symbol/burzu, website a způsobilý kontaktní e-mail firmy. Limity: stockSymbol 10, website 255 a businessContactEmail 255 znaků.
altBusinessIdType, altBusinessIdVolitelný alternativní identifikátor firmy. Uveďte jeho typ a hodnotu společně. Použijte aktuální katalog typů; hodnota povoluje nejvýše 50 znaků.
referenceIdVaše obchodní reference, nejvýše 50 znaků. Uveďte ji při registraci živnostníka podle aktuálních požadavků specifických pro typ subjektu. Jde o obchodní metadata, nikoli o klíč idempotence požadavku.
website, ipAddress, tagDalší web, metadata původní IP a hodnoty značek (tag), pokud to platí. Tyto hodnoty nezakládají vlastnictví účtu ani nenahrazují kontroly identity.
mockJSON boolean. Hodnotu true použijte pouze pro zamýšlený mock pracovní postup; hodnotu false použijte pro explicitně zkontrolovanou produkční registraci. Neodesílejte řetězec "false" jako náhradu za JSON boolean.

Živnostníci jsou podporováni pro registrace v USA nebo Kanadě a před způsobilostí ke kampani potřebují ověření OTP. Veřejně obchodované společnosti mohou vyžadovat krok validace kontaktu firmy. GOVERNMENT je určeno pro vládní subjekty se sídlem v USA; u ostatních organizací ověřte správnou kategorii subjektu. Řiďte se požadavky specifickými pro typ subjektu i vrácenými validačními chybami.

Udržujte stabilní klíč idempotence

Pro tuto zamýšlenou registraci vygenerujte jeden Idempotency-Key. Musí obsahovat 1–128 tisknutelných znaků ASCII bez mezer. Stejný klíč znovu použijte pouze se stejnou metodou HTTP, cestou, řetězcem dotazu a přesně stejnými bajty těla požadavku. Přeformátování JSON, i bez změny jeho významu, mění otisk požadavku.

Dokončený požadavek s klíčem může zopakovat svou uloženou odpověď bez dalšího odeslání registrace. Duplicita, která se stále zpracovává, vrací HTTP 409 a může obsahovat Retry-After. Změněný požadavek se stejným klíčem vyvolá konflikt. Negenerujte nový klíč jen proto, že požadavek vypršel nebo vrátil chybu: firma už mohla být zaregistrována.

Během řešení tohoto požadavku ponechte brand.json beze změny. Odpověď 500 nebo 502 uložená v mezipaměti může zopakovat původní chybu místo opakování registrace. Uchovejte všechny vrácené hodnoty brandId, requestId a korelační hlavičky; před zahájením jiného požadavku sesouhlaste existující značku.

Přečtěte značku a její stav

Toto API používá stavové kódy HTTP a přímé tělo JSON namísto obálky v3 status/response. Úspěšná registrace vrací objekt značky včetně brandId. Uložte tento identifikátor a zkontrolujte vrácený stav validace nebo identity. Další pole závisí na typu subjektu a stavu registrace.

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

Čtěte pouze značku patřící k vašemu účtu. Odpověď 404 může znamenat, že značka není pro tento účet dostupná. Dokončete jakoukoli požadovanou validaci a poté použijte kvalifikaci značky k nalezení dostupných případů použití kampaně. U mock zdrojů nelze předpokládat způsobilost pro produkční odesílání.

Produkční poplatky

Aktuální nakonfigurované poplatky za registraci značky
RegistracePoplatek
Standardní organizace$5.00
Živnostník$4.45
Mock značkaŽádné odepsání poplatku za registraci značky v mock pracovním postupu

Tyto maloobchodní částky byly ověřeny podle aktuální konfigurace portálu dne 24. října 2026. Před produkční registrací potvrďte aktuální poplatek v portálu. Poplatky za kampaně, dodatečné prověřování a využití zasílání zpráv jsou samostatné. Produkční registrace před odesláním kontroluje oprávnění k nákupu a dostupné prostředky; úspěšné vytvoření v registru a místní fakturace jsou samostatné kroky zpracování, proto uchovejte ID zdroje a v případě chyby nebo problému s fakturací sesouhlaste transakce.

Změna mock značky na produkční je samostatně potvrzovaný pracovní postup a může vytvořit novou produkční identitu a poplatek. Nepředpokládejte, že úprava mock na false v pozdějším požadavku převede existující značku.

Zpracujte chyby bez duplikování značky

Selhání registrace
Výsledek HTTPCo zkontrolovat
400Přečtěte chyby polí. Validační chyby registru mohou být pole objektů code/description. Místní validace klíče idempotence může rovněž vrátit 400.
401, 403 nebo 404Zkontrolujte přihlašovací údaje API, povolenou zdrojovou IP účtu API, oprávnění zákazníka a vlastnictví. Odpověď registru může také nést vlastní chybu autorizace.
402Zkontrolujte prostředky a oprávnění k nákupu. Nezacházejte s nefinancovaným produkčním požadavkem jako se sandboxovým testem.
409Při čekání na probíhající požadavek zachovejte stejný klíč a nezměněný požadavek. Konflikt změněného těla/klíče nebo neobnovitelná předchozí odpověď vyžaduje nejprve sesouhlasení.
429 nebo odpověď o nedostupnosti limiteruRespektujte Retry-After, pokud je přítomno. Po uvolnění limitu zopakujte stejný zamýšlený požadavek a klíč.
500 nebo 502Vzdálená operace mohla být přijata. Chyba místního zpracování může obsahovat requestId. Uložte ji a zkontrolujte existující zdroj; nepředpokládejte, že je potřebná náhradní registrace.