Utviklere

POST/tcr/v2/brand/nonBlocking

Registrer en meldingsmerkevare

Registrer en kontoeid virksomhetsidentitet, hold sandkasseforespørsler eksplisitte, og avstem validering og gebyrer.

På denne siden
  1. Registrer virksomheten bak meldingene dine
  2. Start med en eksplisitt sandkasseforespørsel
  3. Virksomhets- og kontaktfelt
  4. Behold en stabil idempotensnøkkel
  5. Les merkevaren og statusen dens
  6. Produksjonsgebyrer
  7. Håndter feil uten å duplisere merkevaren

Registrer virksomheten bak meldingene dine

En meldingsmerkevare identifiserer virksomheten som sender amerikanske 10DLC-meldinger. Registrer merkevaren før du velger et kampanjebrukstilfelle. Bruk virksomhetens juridiske opplysninger og en kontaktperson som kan fullføre eventuell nødvendig validering. En returnert merkevare-ID er ikke i seg selv en godkjenning til å sende meldinger.

Bruk denne gjeldende kontoeide ruten over HTTPS med en aktivert API-konto og dens tillatte kilde-IP-adresse. Ikke send inn user_id, username eller en annen kundes eieridentifikator. MultiTEL registrerer eierskap fra den autentiserte kontoen.

Start med en eksplisitt sandkasseforespørsel

Portalen setter som standard skjemaets mode til sandkasse; en direkte API-forespørsel må eksplisitt inneholde JSON-boolverdien mock: true når du har til hensikt å opprette en mock-merkevare. Å utelate dette flagget er ingen sandkassegaranti og kan opprette en fakturerbar produksjonsregistrering. Portalens mode-felt er ingen erstatning for API-ets mock-felt.

Forbered en lokal brand.json-fil med feltene nedenfor. Erstatt plassholderne med passende testopplysninger og gjeldende katalogkoder. Dette eksemplet er en privat virksomhet med fortjenesteformål; andre enhetstyper har andre krav.

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

Virksomheten, adressen, telefonnummeret og identifikatoren ovenfor er plassholdere, ikke en registreringsklar virksomhetsidentitet. Hent gjeldende verdier for entityType, vertical, country, state, brandRelationship og andre enumerasjoner fra meldingskatalogene.

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'

Virksomhets- og kontaktfelt

Felt for merkevareregistrering
FeltHva som skal oppgis
entityType, displayNameGjeldende enhetstypekode og det gjenkjennelige merkevarenavnet. Maksimal lengde er henholdsvis 20 og 255 tegn.
country, street, city, state, postalCodeDen faktiske virksomhetsadressen. Bruk landkoden på to bokstaver og en gjeldende amerikansk state-kode der det er aktuelt. Grenser: street 255, city 100, state 20 og postalCode 10 tegn.
email, phoneEn fungerende kontakt-e-postadresse, opptil 100 tegn, og et telefonnummer i internasjonalt format med +landkode, opptil 20 tegn. Hold virksomhetsopplysningene konsistente gjennom hele registreringen.
companyName, ein, einIssuingCountryFor organisasjoner oppgir du det juridiske firmanavnet og virksomhetens skatteidentifikator. Identifikatorens utstedende land er et eget felt på to bokstaver. Grenser: companyName 255 og ein 21 tegn. Et enkeltpersonforetak bruker personnavnfelt i stedet for en organisasjons skatteidentitet.
brandRelationship, verticalForholdet til virksomheten og dens bransje, med gjeldende katalogkoder. Organisasjoner krever disse; reglene for enkeltpersonforetak er annerledes. Ikke erstatt API-koder med oversatte visningsetiketter.
firstName, lastName, mobilePhonePåkrevd for et enkeltpersonforetak. Navnefeltene tillater opptil 100 tegn hver. Oppgi et kvalifisert mobilnummer i internasjonalt format for den påkrevde OTP-valideringen.
stockSymbol, stockExchange, website, businessContactEmailEt børsnotert selskap trenger også sitt aksjesymbol/sin børs, website og en kvalifisert forretningskontakt-e-postadresse for den ekstra valideringsprosessen. Grenser: stockSymbol 10, website 255 og businessContactEmail 255 tegn.
altBusinessIdType, altBusinessIdValgfri alternativ virksomhetsidentifikator. Oppgi typen og verdien sammen. Bruk gjeldende typekatalog; verdien tillater opptil 50 tegn.
referenceIdDin virksomhetsreferanse, opptil 50 tegn. Ta den med ved registrering av enkeltpersonforetak i henhold til gjeldende enhetsspesifikke krav. Den er virksomhetsmetadata, ikke forespørselens idempotensnøkkel.
website, ipAddress, tagYtterligere nettsted, metadata om opprinnelses-IP og tag-verdier der det er aktuelt. Disse etablerer ikke kontoeierskap og erstatter ikke identitetskontroller.
mockEn JSON-boolverdi. Bruk true bare for den tilsiktede mock-arbeidsflyten; bruk false for en eksplisitt gjennomgått produksjonsregistrering. Ikke send strengen "false" som erstatning for en JSON-boolverdi.

Enkeltpersonforetak støttes for amerikanske eller kanadiske registreringer og trenger OTP-verifisering før de blir kvalifisert for kampanjer. Børsnoterte selskaper kan kreve et valideringstrinn for forretningskontakt. GOVERNMENT er for amerikanske offentlige enheter; bekreft riktig enhetskategori for andre organisasjoner. Følg de enhetsspesifikke kravene i tillegg til de returnerte valideringsfeilene.

Behold en stabil idempotensnøkkel

Generer én Idempotency-Key for denne tilsiktede registreringen. Den må inneholde 1–128 skrivbare ASCII-tegn uten mellomrom. Gjenbruk den samme nøkkelen bare med samme HTTP-metode, sti, spørrestreng og nøyaktig samme byte i forespørselskroppen. Omformatering av JSON, selv uten å endre betydningen, endrer forespørselens fingeravtrykk.

En fullført nøklet forespørsel kan spille av det lagrede svaret på nytt uten en ny registreringsinnsending. Et duplikat som fortsatt behandles, returnerer HTTP 409 og kan inneholde Retry-After. En endret forespørsel med samme nøkkel gir konflikt. Ikke generer en ny nøkkel bare fordi en forespørsel fikk tidsavbrudd eller returnerte en feil: virksomheten kan allerede være registrert.

Hold brand.json uendret mens du løser den forespørselen. En hurtigbufret 500 eller 502 kan spille av den opprinnelige feilen på nytt i stedet for å prøve registreringen igjen. Ta vare på eventuell returnert brandId, requestId og korrelasjonshoder; avstem den eksisterende merkevaren før du starter en annen forespørsel.

Les merkevaren og statusen dens

Dette API-et bruker HTTP-statuskoder og en direkte JSON-kropp, i stedet for v3-konvolutten status/response. En vellykket registrering returnerer et merkevareobjekt som inneholder brandId. Lagre den identifikatoren og undersøk den returnerte validerings- eller identitetsstatusen. Ekstra felt avhenger av enheten og registreringstilstanden.

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

Les bare en merkevare som tilhører kontoen din. En 404 kan bety at merkevaren ikke er tilgjengelig for denne kontoen. Fullfør eventuell nødvendig validering, og bruk deretter merkevarekvalifisering for å finne de tilgjengelige kampanjebrukstilfellene. Mock-ressurser kan ikke antas å være kvalifisert for produksjonssending.

Produksjonsgebyrer

Gjeldende konfigurerte gebyrer for merkevareregistrering
RegistreringGebyr
Standard organisasjon$5.00
Enkeltpersonforetak$4.45
Mock-merkevareIngen belastning for merkevareregistrering i mock-arbeidsflyten

Disse utsalgsbeløpene ble kontrollert mot gjeldende portalkonfigurasjon 24. oktober 2026. Bekreft gjeldende gebyr i portalen før produksjonsregistrering. Kampanjeavgifter, ytterligere kontroll og meldingsbruk kommer i tillegg. En produksjonsregistrering kontrollerer kjøpstillatelse og tilgjengelig dekning før innsending; vellykket opprettelse i registeret og lokal fakturering er separate behandlingstrinn, så ta vare på ressurs-ID-en og avstem transaksjonene hvis det oppstår en feil eller et faktureringsproblem.

Å endre en mock-merkevare til produksjon er en separat bekreftet arbeidsflyt og kan opprette en ny produksjonsidentitet og belastning. Ikke anta at det å endre mock til false i en senere forespørsel konverterer den eksisterende merkevaren.

Håndter feil uten å duplisere merkevaren

Registreringsfeil
HTTP-resultatHva som skal kontrolleres
400Les feltfeilene. Valideringsfeil fra registeret kan være en matrise av code/description-objekter. Lokal validering av idempotensnøkkelen kan også returnere 400.
401, 403 eller 404Kontroller API-legitimasjonen, API-kontoens tillatte kilde-IP, kundetillatelser og eierskap. Et svar fra registeret kan også bære sin egen autorisasjonsfeil.
402Gjennomgå dekning og kjøpstillatelse. Ikke behandle en udekket produksjonsforespørsel som en sandkassetest.
409Behold samme nøkkel og uendret forespørsel mens du venter på en pågående forespørsel. En konflikt på grunn av endret kropp/nøkkel eller et ikke-gjenopprettbart tidligere svar må avstemmes først.
429 eller et svar om utilgjengelig begrenserRespekter Retry-After når den finnes. Prøv den samme tilsiktede forespørselen og nøkkelen på nytt når begrensningen er opphevet.
500 eller 502Den eksterne operasjonen kan ha blitt godtatt. En lokal behandlingsfeil kan inneholde requestId. Lagre den og kontroller den eksisterende ressursen; ikke anta at en erstatningsregistrering er nødvendig.