Registrer virksomheden bag dine beskeder
Et beskedbrand identificerer virksomheden, der sender US 10DLC-beskeder. Registrer brandet, før du vælger et kampagneanvendelsestilfælde. Brug virksomhedens juridiske oplysninger og en kontaktperson, der kan gennemføre en eventuel påkrævet validering. Et returneret brand-id er ikke i sig selv en tilladelse til at sende beskeder.
Brug denne aktuelle kontoejede rute over HTTPS med en aktiveret API-konto og dens tilladte kilde-IP-adresse. Indsend ikke user_id, username eller en anden kundes ejeridentifikator. MultiTEL registrerer ejerskab ud fra den autentificerede konto.
Start med en eksplicit sandboxanmodning
Portalen indstiller som standard formularens felt mode til sandbox; en direkte API-anmodning skal eksplicit indeholde den boolske JSON-værdi mock: true, når du ønsker et mockbrand. Udeladelse af dette flag er ingen sandboxgaranti og kan oprette en fakturerbar produktionsregistrering. Portalens felt mode er ikke en erstatning for API'ens felt mock.
Forbered en lokal fil brand.json med felterne nedenfor. Erstat pladsholderne med passende testoplysninger og aktuelle katalogkoder. Dette eksempel er en privat virksomhed med gevinst for øje; andre enhedstyper 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
}Virksomheden, adressen, telefonnummeret og identifikatoren ovenfor er pladsholdere, ikke en registreringsklar virksomhedsidentitet. Hent aktuelle værdier for entityType, vertical, country, state, brandRelationship og andre opregninger fra beskedkataloger.
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'Virksomheds- og kontaktfelter
| Felter | Hvad du skal angive |
|---|---|
| entityType, displayName | Aktuel enhedstypekode og det genkendelige brandnavn. Maksimumlængderne er henholdsvis 20 og 255 tegn. |
| country, street, city, state, postalCode | Den faktiske virksomhedsadresse. Brug den tobogstavede landekode og en aktuel US state-kode, når det er relevant. Grænser: street 255, city 100, state 20 og postalCode 10 tegn. |
| email, phone | En fungerende kontakt-e-mail på op til 100 tegn og et telefonnummer i internationalt format med landekode (+landekode) på op til 20 tegn. Hold virksomhedsoplysningerne konsekvente i hele registreringen. |
| companyName, ein, einIssuingCountry | For organisationer skal du angive det juridiske firmanavn og virksomhedens skatteidentifikator. Identifikatorens udstedelsesland er et separat tobogstavet felt. Grænser: companyName 255 og ein 21 tegn. En enkeltmandsvirksomhed bruger felter til personnavne i stedet for en organisations skatteidentitet. |
| brandRelationship, vertical | Forholdet til virksomheden og dens branche ved hjælp af aktuelle katalogkoder. Organisationer skal angive disse; reglerne for enkeltmandsvirksomheder er anderledes. Erstat ikke API-koder med oversatte visningslabels. |
| firstName, lastName, mobilePhone | Påkrævet for en enkeltmandsvirksomhed. Navnefelter må hver indeholde op til 100 tegn. Angiv et mobilnummer i internationalt format, som opfylder kravene til den påkrævede OTP-validering. |
| stockSymbol, stockExchange, website, businessContactEmail | Et børsnoteret selskab skal desuden bruge sit aktiesymbol/børs, website og en e-mail til forretningskontakt, der opfylder kravene til den yderligere valideringsproces. Grænser: stockSymbol 10, website 255 og businessContactEmail 255 tegn. |
| altBusinessIdType, altBusinessId | Valgfri alternativ virksomhedsidentifikator. Angiv dens type og værdi sammen. Brug det aktuelle typekatalog; værdien må indeholde op til 50 tegn. |
| referenceId | Din virksomhedsreference på op til 50 tegn. Medtag den ved registrering af enkeltmandsvirksomhed i henhold til de aktuelle enhedsspecifikke krav. Det er virksomhedsmetadata, ikke anmodningens idempotensnøgle. |
| website, ipAddress, tag | Yderligere website, metadata om oprindelses-IP og tagværdier, når det er relevant. Disse fastslår ikke kontoejerskab og erstatter ikke identitetskontroller. |
| mock | En boolsk JSON-værdi. Brug true kun til den tilsigtede mockarbejdsgang; brug false til en eksplicit gennemgået produktionsregistrering. Send ikke strengen "false" som erstatning for en boolsk JSON-værdi. |
Enkeltmandsvirksomheder understøttes til US- eller canadiske registreringer og kræver OTP-bekræftelse, før de kan blive kampagneberettigede. Børsnoterede selskaber kan kræve et valideringstrin for forretningskontakt. GOVERNMENT er til statslige enheder hjemmehørende i US; bekræft den korrekte enhedskategori for andre organisationer. Følg de enhedsspecifikke krav samt de returnerede valideringsfejl.
Bevar en stabil idempotensnøgle
Generér én Idempotency-Key til denne tilsigtede registrering. Den skal indeholde 1–128 udskrivbare ASCII-tegn uden mellemrum. Genbrug kun den samme nøgle med samme HTTP-metode, sti, forespørgselsstreng og nøjagtige anmodningsbodybytes. Omformatering af JSON, selv uden at ændre betydningen, ændrer anmodningens fingeraftryk.
En fuldført anmodning med nøgle kan afspille sit gemte svar uden endnu en registreringsindsendelse. En duplikat, der stadig behandles, returnerer HTTP 409 og kan indeholde Retry-After. En ændret anmodning med samme nøgle er i konflikt. Generér ikke blot en ny nøgle, fordi en anmodning fik timeout eller returnerede en fejl: virksomheden er muligvis allerede registreret.
Hold brand.json uændret, mens du løser den pågældende anmodning. En cachelagret 500 eller 502 kan afspille den oprindelige fejl i stedet for at forsøge registreringen igen. Bevar et eventuelt returneret brandId, requestId og korrelationsheadere; afstem det eksisterende brand, før du starter en anden anmodning.
Læs brandet og dets status
Denne API bruger HTTP-statuskoder og en direkte JSON-body i stedet for v3-kuverten status/response. En vellykket registrering returnerer et brandobjekt, der indeholder brandId. Gem denne identifikator, og undersøg den returnerede validerings- eller identitetsstatus. Ekstra felter afhænger af enheden og registreringstilstanden.
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/brand/$BRAND_ID"Læs kun et brand, der tilhører din konto. En 404 kan betyde, at brandet ikke er tilgængeligt for denne konto. Gennemfør en eventuel påkrævet validering, og brug derefter brandkvalificering for at finde dets tilgængelige kampagneanvendelsestilfælde. Mockressourcer kan ikke antages at være berettigede til produktionsafsendelse.
Produktionsgebyrer
| Registrering | Gebyr |
|---|---|
| Standardorganisation | $5.00 |
| Enkeltmandsvirksomhed | $4.45 |
| Mockbrand | Ingen debitering for brandregistrering i mockarbejdsgangen |
Disse detailpriser blev kontrolleret mod den aktuelle portalkonfiguration den 24. oktober 2026. Bekræft det aktuelle gebyr i portalen før produktionsregistrering. Kampagnegebyrer, yderligere kontrol og beskedforbrug er separate. En produktionsregistrering kontrollerer købstilladelse og tilgængelig finansiering før indsendelse; vellykket oprettelse i registret og lokal fakturering er separate behandlingstrin, så bevar ressource-id'et og afstem transaktioner, hvis der opstår en fejl eller et faktureringsproblem.
Ændring af et mockbrand til produktion er en særskilt bekræftet arbejdsgang og kan oprette en ny produktionsidentitet og et nyt gebyr. Antag ikke, at redigering af mock til false i en senere anmodning konverterer det eksisterende brand.
Håndter fejl uden at duplikere brandet
| HTTP-resultat | Hvad du skal kontrollere |
|---|---|
| 400 | Læs feltfejlene. Registervalideringsfejl kan være et array af code/description-objekter. Lokal validering af idempotensnøglen kan også returnere 400. |
| 401, 403 eller 404 | Kontroller API-legitimationsoplysninger, API-kontoens tilladte kilde-IP, kundetilladelser og ejerskab. Et registersvar kan også indeholde sin egen autorisationsfejl. |
| 402 | Gennemgå finansiering og købstilladelse. Behandl ikke en ufinansieret produktionsanmodning som en sandboxtest. |
| 409 | Bevar samme nøgle og uændrede anmodning, mens du venter på en anmodning under behandling. En ændret body/nøgle-konflikt eller et uopretteligt tidligere svar kræver først afstemning. |
| 429 eller et svar ved utilgængelig limiter | Respekter Retry-After, når den findes. Prøv den samme tilsigtede anmodning og nøgle igen, når begrænsningen er ophævet. |
| 500 eller 502 | Fjernoperationen er muligvis blevet accepteret. En lokal behandlingsfejl kan indeholde requestId. Gem denne identifikator, og kontroller den eksisterende ressource; antag ikke, at en erstatningsregistrering er nødvendig. |