Arendajad

POST/tcr/v2/brand/nonBlocking

Registreeri sõnumsidebränd

Registreeri kontole kuuluv äriidentiteet, hoia liivakastipäringud selgesõnalised ning kontrolli valideerimist ja tasusid ning lahenda lahknevused.

Sellel lehel
  1. Registreeri oma sõnumite taga olev ettevõte
  2. Alusta selgesõnalise liivakastipäringuga
  3. Ettevõtte ja kontakti väljad
  4. Hoia stabiilset idempotentsusvõtit
  5. Loe brändi ja selle olekut
  6. Tootmistasud
  7. Käsitle vigu brändi dubleerimata

Registreeri oma sõnumite taga olev ettevõte

Sõnumsidebränd tuvastab ettevõtte, kes saadab US 10DLC sõnumeid. Registreeri bränd enne kampaania kasutusjuhtumi valimist. Kasuta ettevõtte juriidilisi andmeid ja kontakti, kes suudab läbida vajaliku valideerimise. Tagastatud brändi ID ei ole iseenesest luba sõnumite saatmiseks.

Kasuta seda praegust kontole kuuluvat marsruuti HTTPS-i kaudu lubatud API konto ja selle lubatud lähte-IP-aadressiga. Ära esita user_id, username ega teise kliendi omanikutunnust. MultiTEL registreerib omandi autentitud konto alusel.

Alusta selgesõnalise liivakastipäringuga

Portaali vormi mode-väli on vaikimisi liivakastirežiimis; otsene API päring peab selgesõnaliselt sisaldama JSON-i tõeväärtust mock: true, kui kavatsed luua näidisbrändi. Selle lipu ärajätmine ei garanteeri liivakasti kasutamist ja võib luua arveldatava tootmisregistreerimise. Portaali väli mode ei asenda API välja mock.

Valmista kohalik fail brand.json ette, kasutades allpool olevaid välju. Asenda kohahoidjad sobivate testandmete ja praeguste kataloogikoodidega. See näide on era-kasumiettevõte; teistel üksuse tüüpidel on erinevad nõuded.

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

Ülalolev ettevõte, aadress, telefon ja tunnus on kohahoidjad, mitte registreerimisvalmis äriidentiteet. Hangi väljade entityType, vertical, country, state, brandRelationship ja muude loendite praegused väärtused järgmistest sõnumsidekataloogidest.

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'

Ettevõtte ja kontakti väljad

Brändi registreerimise väljad
VäljadMida esitada
entityType, displayNamePraegune üksuse tüübi kood ja äratuntav brändinimi. Maksimaalsed pikkused on vastavalt 20 ja 255 tähemärki.
country, street, city, state, postalCodeTegelik ettevõtte aadress. Kasuta vajaduse korral kahetähelist riigikoodi ja praegust US state koodi. Piirangud: street 255, city 100, state 20 ja postalCode 10 tähemärki.
email, phoneToimiv kontakt-e-posti aadress kuni 100 tähemärki ja telefoninumber rahvusvahelises +riigikoodiga vormingus kuni 20 tähemärki. Hoia ettevõtte andmed kogu registreerimise vältel järjepidevad.
companyName, ein, einIssuingCountryOrganisatsioonide puhul esita ettevõtte juriidiline nimi ja äriline maksuidentifikaator. Identifikaatori väljastanud riik on eraldi kahetäheline väli. Piirangud: companyName 255 ja ein 21 tähemärki. Füüsilisest isikust ettevõtja kasutab organisatsiooni maksuidentiteedi asemel isikunime välju.
brandRelationship, verticalSuhe ettevõttesse ja selle tegevusala, kasutades praeguseid kataloogikoode. Organisatsioonidel on need kohustuslikud; füüsilisest isikust ettevõtja reeglid erinevad. Ära asenda API koode tõlgitud kuvasiltidega.
firstName, lastName, mobilePhoneKohustuslik füüsilisest isikust ettevõtjale. Nimeväljad võimaldavad kumbki kuni 100 tähemärki. Esita nõutava OTP-valideerimise jaoks sobiv mobiilinumber rahvusvahelises vormingus.
stockSymbol, stockExchange, website, businessContactEmailBörsiettevõte vajab täiendava valideerimisprotsessi jaoks ka aktsiasümbolit/börsi, website ja sobivat ärikontakti e-posti aadressi. Piirangud: stockSymbol 10, website 255 ja businessContactEmail 255 tähemärki.
altBusinessIdType, altBusinessIdValikuline alternatiivne äritunnus. Esita selle tüüp ja väärtus koos. Kasuta praegust tüübikataloogi; väärtus võimaldab kuni 50 tähemärki.
referenceIdSinu ettevõtte viide, kuni 50 tähemärki. Lisa see füüsilisest isikust ettevõtja registreerimisel vastavalt praegustele üksusepõhistele nõuetele. See on äriline metaandmestik, mitte päringu idempotentsusvõti.
website, ipAddress, tagTäiendav veebisait, lähte-IP metaandmed ja sildi väärtused, kui see on kohaldatav. Need ei tõenda konto omandit ega asenda isikusamasuse kontrolle.
mockJSON-i tõeväärtus. Kasuta true ainult kavandatud näidistöövoo jaoks; kasuta false selgesõnaliselt üle vaadatud tootmisregistreerimise jaoks. Ära saada JSON-i tõeväärtuse asendajana stringi "false".

Füüsilisest isikust ettevõtjad on toetatud US või Kanada registreerimiste puhul ja vajavad enne kampaaniakõlblikkust OTP-kinnitust. Börsiettevõtted võivad vajada ärikontakti valideerimise sammu. GOVERNMENT on mõeldud US-põhistele valitsusasutustele; kinnita teiste organisatsioonide puhul õige üksuse kategooria. Järgi üksusepõhiseid nõudeid ning tagastatud valideerimisvigu.

Hoia stabiilset idempotentsusvõtit

Genereeri selle kavandatud registreerimise jaoks üks Idempotency-Key. See peab sisaldama 1–128 prinditavat ASCII tähemärki ilma tühikuteta. Korda sama võtit ainult sama HTTP-meetodi, tee, päringustringi ja täpsete päringu keha baitidega. JSON-i ümbervormindamine, isegi selle tähendust muutmata, muudab päringu sõrmejälge.

Lõpetatud võtmega päring võib esitada oma salvestatud vastuse uuesti ilma uut registreerimist esitamata. Veel töödeldav duplikaat tagastab HTTP 409 ja võib sisaldada Retry-After. Sama võtmega muudetud päring on vastuolus. Ära genereeri uut võtit ainult seetõttu, et päring aegus või tagastas vea: ettevõte võib olla juba registreeritud.

Hoia brand.json selle päringu lahendamise ajal muutmata. Vahemällu salvestatud 500 või 502 võib registreerimise uuesti proovimise asemel esitada uuesti algse vea. Säilita kõik tagastatud brandId, requestId ja korrelatsiooni päised; enne teise päringu alustamist kontrolli olemasoleva brändi tegelikku olekut ja lahenda lahknevused.

Loe brändi ja selle olekut

See API kasutab HTTP olekukoode ja otsest JSON-i keha, mitte v3 status/response ümbrist. Edukas registreerimine tagastab brändiobjekti, mis sisaldab brandId. Salvesta see identifikaator ning kontrolli tagastatud valideerimis- või identiteediolekut. Lisaväljad sõltuvad üksusest ja registreerimise olekust.

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

Loe ainult oma kontole kuuluvat brändi. 404 võib tähendada, et bränd ei ole sellele kontole saadaval. Lõpeta vajalik valideerimine ja seejärel kasuta brändi kvalifitseerimist selle saadaolevate kampaania kasutusjuhtumite leidmiseks. Näidisressursse ei saa pidada tootmissaatmiseks sobivaks.

Tootmistasud

Praegused konfigureeritud brändi registreerimise tasud
RegistreerimineTasu
Tavaline organisatsioon$5.00
Füüsilisest isikust ettevõtja$4.45
NäidisbrändNäidistöövoos brändi registreerimise deebetit ei ole

Neid jaehindu kontrolliti praeguse portaali konfiguratsiooni alusel 24. oktoobril 2026. Kinnita praegune tasu portaalis enne tootmisregistreerimist. Kampaaniatasud, täiendav taustakontroll ja sõnumsidekasutus on eraldi. Tootmisregistreerimine kontrollib enne esitamist ostuluba ja saadaolevat rahastust; edukas registrikanne ja kohalik arveldus on eraldi töötlusetapid, seega säilita ressursi ID ja kontrolli tehinguid ja lahenda lahknevused, kui tekib viga või arveldusprobleem.

Näidisbrändi muutmine tootmiseks on eraldi kinnitatav töövoog ja võib luua uue tootmisidentiteedi ning tasu. Ära eelda, et mock muutmine väärtuseks false hilisemas päringus teisendab olemasoleva brändi.

Käsitle vigu brändi dubleerimata

Registreerimise tõrked
HTTP tulemusMida kontrollida
400Loe väljade vigu. Registri valideerimisvead võivad olla code/description objektide massiiv. Kohalik idempotentsusvõtme valideerimine võib samuti tagastada 400.
401, 403 või 404Kontrolli API mandaate, API konto lubatud lähte-IP-d, kliendi õigusi ja omandit. Registri vastus võib sisaldada ka oma autoriseerimisviga.
402Vaata üle rahastus ja ostuluba. Ära käsitle rahastamata tootmispäringut liivakastitestina.
409Hoia poolelioleva päringu ootamisel sama võtit ja muutmata päringut. Muudetud keha/võtme konflikt või taastamatu eelnev vastus vajab esmalt tegeliku oleku kontrollimist ja lahknevuste lahendamist.
429 või piiraja kättesaamatuse vastusJärgi Retry-After, kui see on olemas. Proovi sama kavandatud päringut ja võtit uuesti pärast limiidi vabanemist.
500 või 502Kaugoperatsioon võis olla aktsepteeritud. Kohaliku töötluse viga võib sisaldada requestId. Salvesta see ja kontrolli olemasolevat ressurssi; ära eelda, et asendusregistreerimine on vajalik.