Fejlesztők

POST/tcr/v2/brand/nonBlocking

Üzenetküldési márka regisztrálása

Regisztráljon egy fiókhoz tartozó üzleti identitást, tegye egyértelművé a sandbox kéréseket, és egyeztesse az érvényesítést és a díjakat.

Ezen az oldalon
  1. Regisztrálja az üzenetei mögött álló vállalkozást
  2. Kezdje egyértelmű sandbox kéréssel
  3. Üzleti és kapcsolattartási mezők
  4. Tartson stabil idempotenciakulcsot
  5. A márka és állapotának olvasása
  6. Éles díjak
  7. Hibák kezelése a márka duplikálása nélkül

Regisztrálja az üzenetei mögött álló vállalkozást

Az üzenetküldési márka azonosítja az US 10DLC üzeneteket küldő vállalkozást. Regisztrálja a márkát, mielőtt kampány-felhasználási esetet választana. Használja a vállalkozás hivatalos adatait és egy olyan kapcsolattartót, aki el tudja végezni a szükséges érvényesítést. A visszaadott márkaazonosító önmagában nem jelent engedélyt üzenetek küldésére.

Használja ezt az aktuális, fiókhoz tartozó útvonalat HTTPS-en keresztül, engedélyezett API-fiókkal és annak engedélyezett forrás IP-címével. Ne küldjön user_id vagy username mezőt, illetve másik ügyfél tulajdonosi azonosítóját. A MultiTEL a tulajdonjogot a hitelesített fiók alapján rögzíti.

Kezdje egyértelmű sandbox kéréssel

A portál űrlapján a mode mező alapértelmezett értéke sandbox; a közvetlen API-kérésnek kifejezetten tartalmaznia kell a mock: true JSON logikai értéket, ha mock márkát szeretne. A jelző elhagyása nem garantálja a sandboxot, és számlázható éles regisztrációt hozhat létre. A portál mode mezője nem helyettesíti az API mock mezőjét.

Készítsen elő egy helyi brand.json fájlt az alábbi mezőkkel. Cserélje le a helyőrzőket megfelelő tesztadatokra és aktuális katalóguskódokra. Ez a példa egy nyereségorientált magánvállalkozás; más entitástípusokra eltérő követelmények vonatkoznak.

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

A fenti vállalkozás, cím, telefonszám és azonosító helyőrző, nem regisztrációra kész üzleti identitás. Az entityType, vertical, country, state, brandRelationship és a többi felsorolás aktuális értékeit itt találja: üzenetküldési katalógusok.

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'

Üzleti és kapcsolattartási mezők

Márkaregisztrációs mezők
MezőkMit kell megadni
entityType, displayNameAz aktuális entitástípus-kód és a felismerhető márkanév. A maximális hossz 20, illetve 255 karakter.
country, street, city, state, postalCodeA vállalkozás tényleges címe. Használja a kétbetűs országkódot és adott esetben az aktuális US state kódot. Korlátok: street 255, city 100, state 20 és postalCode 10 karakter.
email, phoneMűködő kapcsolattartási e-mail-cím, legfeljebb 100 karakter, és nemzetközi, +országhívószám formátumú telefonszám, legfeljebb 20 karakter. Az üzleti adatok legyenek következetesek az egész regisztrációban.
companyName, ein, einIssuingCountrySzervezetek esetén adja meg a hivatalos cégnevet és az üzleti adóazonosítót. Az azonosítót kibocsátó ország külön, kétbetűs mező. Korlátok: companyName 255 és ein 21 karakter. Az egyéni vállalkozó a szervezeti adóazonosság helyett a személynév-mezőket használja.
brandRelationship, verticalA vállalkozáshoz fűződő viszony és annak iparága, aktuális katalóguskódokkal. Szervezeteknél ezek kötelezők; az egyéni vállalkozókra vonatkozó szabályok eltérnek. Ne helyettesítse az API-kódokat lefordított megjelenítési címkékkel.
firstName, lastName, mobilePhoneEgyéni vállalkozó esetén kötelező. A névmezők egyenként legfeljebb 100 karaktert fogadnak el. Adjon meg a kötelező OTP-érvényesítéshez alkalmas mobilszámot, nemzetközi formátumban.
stockSymbol, stockExchange, website, businessContactEmailA nyilvános részvénytársaságnak szüksége van a tőzsdei szimbólumára/tőzsdéjére, a website értékre és egy alkalmas üzleti kapcsolattartási e-mail-címre is a további érvényesítési folyamathoz. Korlátok: stockSymbol 10, website 255 és businessContactEmail 255 karakter.
altBusinessIdType, altBusinessIdOpcionális alternatív üzleti azonosító. A típusát és az értékét együtt adja meg. Használja az aktuális típuskatalógust; az érték legfeljebb 50 karakter lehet.
referenceIdAz Ön üzleti hivatkozása, legfeljebb 50 karakter. Egyéni vállalkozói regisztrációnál az aktuális entitásspecifikus követelmények szerint adja meg. Ez üzleti metaadat, nem a kérés idempotenciakulcsa.
website, ipAddress, tagTovábbi weboldal, forrás-IP metaadatok és címkeértékek, ha alkalmazhatók. Ezek nem alapoznak meg fióktulajdonjogot, és nem helyettesítik az identitásellenőrzést.
mockJSON logikai érték. A true értéket csak a szándékolt mock munkafolyamathoz használja; a false értéket kifejezetten átnézett éles regisztrációhoz. Ne küldje a "false" karakterláncot JSON logikai érték helyett.

Egyéni vállalkozók US vagy kanadai regisztrációhoz támogatottak, és a kampányjogosultság előtt OTP-ellenőrzésre van szükségük. Nyilvános részvénytársaságoknál üzleti kapcsolattartó érvényesítési lépésre lehet szükség. A GOVERNMENT az USA-ban székhellyel rendelkező kormányzati szervezeteknek szól; más szervezeteknél erősítse meg a helyes entitáskategóriát. Kövesse az entitásspecifikus követelményeket és a visszaadott érvényesítési hibákat is.

Tartson stabil idempotenciakulcsot

Hozzon létre egy Idempotency-Key értéket ehhez a szándékolt regisztrációhoz. 1–128 nyomtatható ASCII karakterből kell állnia, szóköz nélkül. Ugyanazt a kulcsot csak ugyanazzal a HTTP-metódussal, útvonallal, lekérdezési karakterlánccal és pontosan ugyanazokkal a kéréstörzs-bájtokkal használja újra. A JSON újraformázása, még ha a jelentése nem is változik, megváltoztatja a kérés ujjlenyomatát.

A befejezett kulcsos kérés a tárolt választ újabb regisztrációs beküldés nélkül visszajátszhatja. A még feldolgozás alatt álló duplikátum HTTP 409 választ ad, és tartalmazhat Retry-After fejlécet. Az azonos kulcsú, de módosított kérés ütközik. Ne hozzon létre új kulcsot pusztán azért, mert a kérés időtúllépéssel vagy hibával tért vissza: a vállalkozás lehet, hogy már regisztrálva van.

Hagyja változatlanul a brand.json fájlt, amíg ezt a kérést rendezi. A gyorsítótárazott 500 vagy 502 az eredeti hibát játszhatja vissza a regisztráció újrapróbálása helyett. Őrizze meg a visszaadott brandId, requestId és korrelációs fejléceket; egyeztesse a meglévő márkát, mielőtt másik kérést indítana.

A márka és állapotának olvasása

Ez az API HTTP-állapotkódokat és közvetlen JSON-törzset használ a v3 status/response burkoló helyett. A sikeres regisztráció egy márkaobjektumot ad vissza, amely tartalmazza a brandId értéket. Tárolja ezt az azonosítót, és vizsgálja meg a visszaadott érvényesítési vagy identitásállapotot. A további mezők az entitástól és a regisztráció állapotától függenek.

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

Csak a saját fiókjához tartozó márkát olvassa. A 404 azt is jelentheti, hogy a márka nem érhető el ehhez a fiókhoz. Végezze el a szükséges érvényesítést, majd használja a márkaminősítés funkciót az elérhető kampány-felhasználási esetek megtalálásához. A mock erőforrásokról nem feltételezhető, hogy éles küldésre jogosultak.

Éles díjak

Jelenleg konfigurált márkaregisztrációs díjak
RegisztrációDíj
Normál szervezet$5.00
Egyéni vállalkozó$4.45
Mock márkaNincs márkaregisztrációs terhelés a mock munkafolyamatban

Ezeket a kiskereskedelmi összegeket október 24-én, 2026-ban ellenőriztük az aktuális portálkonfiguráció alapján. Éles regisztráció előtt erősítse meg az aktuális díjat a portálon. A kampánydíjak, a további átvilágítás és az üzenetküldési használat külön tételek. Az éles regisztráció a beküldés előtt ellenőrzi a vásárlási engedélyt és a rendelkezésre álló fedezetet; a sikeres nyilvántartási létrehozás és a helyi számlázás külön feldolgozási lépések, ezért őrizze meg az erőforrás-azonosítót, és hiba vagy számlázási probléma esetén egyeztesse a tranzakciókat.

A mock márka élesre váltása külön megerősítendő munkafolyamat, és új éles identitást és terhelést hozhat létre. Ne feltételezze, hogy a mock false értékre módosítása egy későbbi kérésben átalakítja a meglévő márkát.

Hibák kezelése a márka duplikálása nélkül

Regisztrációs hibák
HTTP-eredményMit kell ellenőrizni
400Olvassa el a mezőhibákat. A nyilvántartás érvényesítési hibái code/description objektumok tömbjeként érkezhetnek. A helyi idempotenciakulcs-érvényesítés szintén 400 választ adhat.
401, 403 vagy 404Ellenőrizze az API-hitelesítő adatokat, az API-fiók engedélyezett forrás IP-címét, az ügyféljogosultságokat és a tulajdonjogot. A nyilvántartás válasza saját engedélyezési hibát is hordozhat.
402Ellenőrizze a fedezetet és a vásárlási engedélyt. Ne kezelje a fedezet nélküli éles kérést sandbox tesztként.
409Tartsa meg ugyanazt a kulcsot és a változatlan kérést, amíg a folyamatban lévő kérésre vár. A módosított törzs/kulcs ütközés vagy a helyreállíthatatlan korábbi válasz először egyeztetést igényel.
429 vagy limiter-nem-elérhető válaszVegye figyelembe a Retry-After fejlécet, ha jelen van. A korlát feloldása után próbálja újra ugyanazt a szándékolt kérést és kulcsot.
500 vagy 502A távoli művelet elfogadásra kerülhetett. A helyi feldolgozási hiba tartalmazhat requestId értéket. Mentse el, és ellenőrizze a meglévő erőforrást; ne feltételezze, hogy helyettesítő regisztrációra van szükség.