Registrera företaget bakom dina meddelanden
Ett meddelandevarumärke identifierar det företag som skickar amerikanska 10DLC-meddelanden. Registrera varumärket innan du väljer ett kampanjanvändningsfall. Använd företagets juridiska uppgifter och en kontaktperson som kan slutföra eventuell nödvändig validering. Ett returnerat varumärkes-ID är inte i sig ett godkännande att skicka meddelanden.
Använd den här aktuella kontoägda rutten över HTTPS med ett aktiverat API-konto och dess tillåtna käll-IP-adress. Skicka inte in user_id, username eller en annan kunds ägaridentifierare. MultiTEL registrerar ägarskap utifrån det autentiserade kontot.
Börja med en explicit sandlådeförfrågan
Portalen sätter som standard formulärets mode till sandlåda; en direkt API-förfrågan måste uttryckligen innehålla JSON-booleanen mock: true när du avser att skapa ett mock-varumärke. Att utelämna den flaggan är ingen sandlådegaranti och kan skapa en debiterbar produktionsregistrering. Portalens mode-fält ersätter inte API:ets mock-fält.
Förbered en lokal brand.json-fil med fälten nedan. Ersätt platshållarna med lämpliga testuppgifter och aktuella katalogkoder. Det här exemplet är ett privat vinstdrivande företag; andra entitetstyper har andra 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
}Företaget, adressen, telefonnumret och identifieraren ovan är platshållare, inte en registreringsklar företagsidentitet. Hämta aktuella värden för entityType, vertical, country, state, brandRelationship och andra uppräkningar från meddelandekatalogerna.
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'Företags- och kontaktfält
| Fält | Vad som ska anges |
|---|---|
| entityType, displayName | Aktuell entitetstypskod och det igenkännbara varumärkesnamnet. Maximala längder är 20 respektive 255 tecken. |
| country, street, city, state, postalCode | Den faktiska företagsadressen. Använd landskoden med två bokstäver och en aktuell amerikansk state-kod när det är tillämpligt. Gränser: street 255, city 100, state 20 och postalCode 10 tecken. |
| email, phone | En fungerande kontakt-e-postadress, upp till 100 tecken, och ett telefonnummer i internationellt format med +landskod, upp till 20 tecken. Håll företagsuppgifterna konsekventa genom hela registreringen. |
| companyName, ein, einIssuingCountry | För organisationer anger du det juridiska företagsnamnet och företagets skatteidentifierare. Identifierarens utfärdande land är ett separat fält med två bokstäver. Gränser: companyName 255 och ein 21 tecken. En enskild näringsidkare använder personnamnsfält i stället för en organisations skatteidentitet. |
| brandRelationship, vertical | Relationen till företaget och dess bransch, med aktuella katalogkoder. Organisationer kräver dessa; reglerna för enskilda näringsidkare skiljer sig. Ersätt inte API-koder med översatta visningsetiketter. |
| firstName, lastName, mobilePhone | Krävs för en enskild näringsidkare. Namnfälten tillåter upp till 100 tecken vardera. Ange ett mobilnummer som uppfyller kraven i internationellt format för den obligatoriska OTP-valideringen. |
| stockSymbol, stockExchange, website, businessContactEmail | Ett börsnoterat företag behöver även sin aktiesymbol/börs, website och en e-postadress för företagskontakt som uppfyller kraven för den ytterligare valideringsprocessen. Gränser: stockSymbol 10, website 255 och businessContactEmail 255 tecken. |
| altBusinessIdType, altBusinessId | Valfri alternativ företagsidentifierare. Ange dess typ och värde tillsammans. Använd den aktuella typkatalogen; värdet tillåter upp till 50 tecken. |
| referenceId | Din företagsreferens, upp till 50 tecken. Ta med den vid registrering av enskild näringsidkare enligt de aktuella entitetsspecifika kraven. Den är företagsmetadata, inte förfrågans idempotensnyckel. |
| website, ipAddress, tag | Ytterligare webbplats, metadata om ursprungs-IP och taggvärden när det är tillämpligt. Dessa etablerar inte kontoägarskap och ersätter inte identitetskontroller. |
| mock | En JSON-boolean. Använd true endast för det avsedda mock-arbetsflödet; använd false för en uttryckligen granskad produktionsregistrering. Skicka inte strängen "false" som ersättning för en JSON-boolean. |
Enskilda näringsidkare stöds för amerikanska eller kanadensiska registreringar och behöver OTP-verifiering innan de blir kampanjberättigade. Börsnoterade företag kan kräva ett valideringssteg för företagskontakt. GOVERNMENT är avsett för amerikanska myndighetsentiteter; bekräfta rätt entitetskategori för andra organisationer. Följ de entitetsspecifika kraven såväl som de returnerade valideringsfelen.
Behåll en stabil idempotensnyckel
Generera en Idempotency-Key för den här avsedda registreringen. Den måste innehålla 1–128 utskrivbara ASCII-tecken utan blanksteg. Återanvänd samma nyckel endast med samma HTTP-metod, sökväg, frågesträng och exakt samma byte i förfrågningskroppen. Omformatering av JSON, även utan att ändra dess innebörd, ändrar förfrågans fingeravtryck.
En slutförd nycklad förfrågan kan spela upp sitt lagrade svar igen utan en ny registreringsinskickning. En dubblett som fortfarande bearbetas returnerar HTTP 409 och kan innehålla Retry-After. En ändrad förfrågan med samma nyckel ger en konflikt. Generera inte en ny nyckel bara för att en förfrågan fick timeout eller returnerade ett fel: företaget kan redan ha registrerats.
Håll brand.json oförändrad medan du reder ut den förfrågan. En cachad 500 eller 502 kan spela upp det ursprungliga felet igen i stället för att försöka registreringen på nytt. Behåll eventuellt returnerat brandId, requestId och korrelationshuvuden; stäm av det befintliga varumärket innan du påbörjar en annan förfrågan.
Läs varumärket och dess status
Det här API:et använder HTTP-statuskoder och en direkt JSON-kropp, i stället för v3-kuvertet status/response. En lyckad registrering returnerar ett varumärkesobjekt som innehåller brandId. Spara den identifieraren och granska den returnerade validerings- eller identitetsstatusen. Extra fält beror på entiteten och registreringstillståndet.
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/brand/$BRAND_ID"Läs endast ett varumärke som tillhör ditt konto. En 404 kan betyda att varumärket inte är tillgängligt för det här kontot. Slutför eventuell nödvändig validering och använd sedan varumärkeskvalificering för att hitta dess tillgängliga kampanjanvändningsfall. Mock-resurser kan inte antas vara berättigade för produktionsutskick.
Produktionsavgifter
| Registrering | Avgift |
|---|---|
| Standardorganisation | $5.00 |
| Enskild näringsidkare | $4.45 |
| Mock-varumärke | Ingen debitering för varumärkesregistrering i mock-arbetsflödet |
Dessa detaljhandelsbelopp kontrollerades mot den aktuella portalkonfigurationen den 24 oktober 2026. Bekräfta den aktuella avgiften i portalen före produktionsregistrering. Kampanjavgifter, ytterligare granskning och meddelandeanvändning tillkommer separat. En produktionsregistrering kontrollerar köpbehörighet och tillgängliga medel före inskickning; lyckat skapande i registret och lokal fakturering är separata bearbetningssteg, så behåll resurs-ID:t och stäm av transaktionerna om ett fel eller faktureringsproblem uppstår.
Att ändra ett mock-varumärke till produktion är ett separat bekräftat arbetsflöde och kan skapa en ny produktionsidentitet och debitering. Anta inte att en ändring av mock till false i en senare förfrågan konverterar det befintliga varumärket.
Hantera fel utan att duplicera varumärket
| HTTP-resultat | Vad som ska kontrolleras |
|---|---|
| 400 | Läs fältfelen. Valideringsfel från registret kan vara en array av code/description-objekt. Lokal validering av idempotensnyckeln kan också returnera 400. |
| 401, 403 eller 404 | Kontrollera API-uppgifterna, API-kontots tillåtna käll-IP, kundbehörigheter och ägarskap. Ett svar från registret kan också bära sitt eget auktoriseringsfel. |
| 402 | Granska medel och köpbehörighet. Behandla inte en ofinansierad produktionsförfrågan som ett sandlådetest. |
| 409 | Behåll samma nyckel och oförändrad förfrågan när du väntar på en pågående förfrågan. En konflikt på grund av ändrad kropp/nyckel eller ett oåterställbart tidigare svar måste stämmas av först. |
| 429 eller ett svar om otillgänglig begränsare | Respektera Retry-After när det finns. Försök igen med samma avsedda förfrågan och nyckel när begränsningen har släppt. |
| 500 eller 502 | Den fjärranslutna operationen kan ha accepterats. Ett lokalt bearbetningsfel kan innehålla requestId. Spara det och kontrollera den befintliga resursen; anta inte att en ersättningsregistrering behövs. |