Programiści

POST/tcr/v2/brand/nonBlocking

Rejestracja marki wiadomości

Zarejestruj tożsamość firmy należącą do konta, składaj jawne żądania piaskownicy oraz uzgadniaj walidację i opłaty.

Na tej stronie
  1. Zarejestruj firmę stojącą za Twoimi wiadomościami
  2. Zacznij od jawnego żądania piaskownicy
  3. Pola firmy i kontaktu
  4. Zachowaj stabilny klucz idempotencji
  5. Odczytaj markę i jej status
  6. Opłaty produkcyjne
  7. Obsługuj błędy bez duplikowania marki

Zarejestruj firmę stojącą za Twoimi wiadomościami

Marka wiadomości identyfikuje firmę wysyłającą wiadomości 10DLC w USA. Zarejestruj markę przed wyborem przypadku użycia kampanii. Użyj danych prawnych firmy oraz osoby kontaktowej, która może ukończyć wymaganą walidację. Zwrócony identyfikator marki nie jest sam w sobie zgodą na wysyłanie wiadomości.

Używaj tej bieżącej trasy należącej do konta przez HTTPS z włączonym kontem API i jego dozwolonym źródłowym adresem IP. Nie przesyłaj user_id, username ani identyfikatora właściciela innego klienta. MultiTEL zapisuje własność na podstawie uwierzytelnionego konta.

Zacznij od jawnego żądania piaskownicy

Portal domyślnie ustawia pole mode formularza na tryb piaskownicy; bezpośrednie żądanie API musi jawnie zawierać wartość logiczną JSON mock: true, gdy zamierzasz utworzyć markę testową. Pominięcie tej flagi nie gwarantuje piaskownicy i może utworzyć płatną rejestrację produkcyjną. Pole mode portalu nie zastępuje pola mock interfejsu API.

Przygotuj lokalny plik brand.json z użyciem poniższych pól. Zastąp symbole zastępcze odpowiednimi danymi testowymi i aktualnymi kodami z katalogów. Ten przykład dotyczy prywatnej firmy nastawionej na zysk; inne typy podmiotów mają inne wymagania.

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

Powyższa firma, adres, telefon i identyfikator to symbole zastępcze, a nie tożsamość firmy gotowa do rejestracji. Aktualne wartości entityType, vertical, country, state, brandRelationship i innych wyliczeń pobierz z katalogów wiadomości.

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'

Pola firmy i kontaktu

Pola rejestracji marki
PolaCo podać
entityType, displayNameAktualny kod typu podmiotu oraz rozpoznawalna nazwa marki. Maksymalne długości to odpowiednio 20 i 255 znaków.
country, street, city, state, postalCodeRzeczywisty adres firmy. Użyj dwuliterowego kodu kraju oraz, jeśli dotyczy, aktualnego kodu state w USA. Limity: street 255, city 100, state 20 i postalCode 10 znaków.
email, phoneDziałający kontaktowy adres e-mail, do 100 znaków, oraz numer telefonu w międzynarodowym formacie z kodem kraju po znaku +, do 20 znaków. Zachowaj spójność danych firmy w całej rejestracji.
companyName, ein, einIssuingCountryW przypadku organizacji podaj prawną nazwę firmy i identyfikator podatkowy firmy. Kraj wydania identyfikatora to osobne dwuliterowe pole. Limity: companyName 255 i ein 21 znaków. Osoba prowadząca jednoosobową działalność używa pól z imieniem i nazwiskiem zamiast tożsamości podatkowej organizacji.
brandRelationship, verticalRelacja z firmą i jej branża, z użyciem aktualnych kodów z katalogów. Organizacje muszą je podać; zasady dla jednoosobowej działalności są inne. Nie zastępuj kodów API przetłumaczonymi etykietami wyświetlanymi.
firstName, lastName, mobilePhoneWymagane dla jednoosobowej działalności. Pola imienia i nazwiska pozwalają na maksymalnie 100 znaków każde. Podaj kwalifikujący się numer telefonu komórkowego do wymaganej walidacji OTP, w formacie międzynarodowym.
stockSymbol, stockExchange, website, businessContactEmailSpółka publiczna potrzebuje też swojego symbolu giełdowego/giełdy, pola website oraz kwalifikującego się firmowego kontaktowego adresu e-mail do dodatkowego procesu walidacji. Limity: stockSymbol 10, website 255 i businessContactEmail 255 znaków.
altBusinessIdType, altBusinessIdOpcjonalny alternatywny identyfikator firmy. Podaj razem jego typ i wartość. Użyj aktualnego katalogu typów; wartość może mieć do 50 znaków.
referenceIdTwoje odniesienie biznesowe, do 50 znaków. Dołącz je przy rejestracji jednoosobowej działalności zgodnie z aktualnymi wymaganiami dla danego typu podmiotu. To metadane biznesowe, a nie klucz idempotencji żądania.
website, ipAddress, tagDodatkowe wartości strony internetowej, metadanych źródłowego adresu IP i tagu, jeśli mają zastosowanie. Nie ustanawiają one własności konta ani nie zastępują kontroli tożsamości.
mockWartość logiczna JSON. Używaj true tylko dla zamierzonego przepływu testowego; używaj false dla jawnie sprawdzonej rejestracji produkcyjnej. Nie wysyłaj ciągu znaków "false" jako zamiennika wartości logicznej JSON.

Jednoosobowe działalności są obsługiwane dla rejestracji w USA lub Kanadzie i wymagają weryfikacji OTP przed uzyskaniem kwalifikacji do kampanii. Spółki publiczne mogą wymagać kroku walidacji firmowego kontaktu. GOVERNMENT jest przeznaczone dla podmiotów rządowych z siedzibą w USA; w przypadku innych organizacji potwierdź właściwą kategorię podmiotu. Przestrzegaj wymagań dla danego typu podmiotu oraz zwróconych błędów walidacji.

Zachowaj stabilny klucz idempotencji

Wygeneruj jeden Idempotency-Key dla tej zamierzonej rejestracji. Musi on zawierać 1–128 drukowalnych znaków ASCII bez spacji. Używaj ponownie tego samego klucza tylko z tą samą metodą HTTP, ścieżką, ciągiem zapytania i dokładnie tymi samymi bajtami treści żądania. Zmiana formatowania JSON, nawet bez zmiany jego znaczenia, zmienia odcisk żądania.

Zakończone żądanie z kluczem może odtworzyć zapisaną odpowiedź bez ponownego przesyłania rejestracji. Duplikat, który wciąż jest przetwarzany, zwraca HTTP 409 i może zawierać Retry-After. Zmienione żądanie z tym samym kluczem powoduje konflikt. Nie generuj nowego klucza tylko dlatego, że żądanie przekroczyło limit czasu lub zwróciło błąd: firma mogła już zostać zarejestrowana.

Nie zmieniaj pliku brand.json podczas rozwiązywania tego żądania. Zbuforowany błąd 500 lub 502 może odtworzyć pierwotny błąd zamiast ponowić rejestrację. Zachowaj wszelkie zwrócone brandId, requestId i nagłówki korelacji; sprawdź rzeczywisty stan istniejącej marki i wyjaśnij ewentualne rozbieżności przed rozpoczęciem innego żądania.

Odczytaj markę i jej status

To API używa kodów statusu HTTP i bezpośredniej treści JSON, a nie koperty status/response z wersji v3. Pomyślna rejestracja zwraca obiekt marki zawierający brandId. Zapisz ten identyfikator i sprawdź zwrócony status walidacji lub tożsamości. Dodatkowe pola zależą od podmiotu i stanu rejestracji.

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

Odczytuj tylko markę należącą do Twojego konta. Kod 404 może oznaczać, że marka nie jest dostępna dla tego konta. Ukończ wymaganą walidację, a następnie użyj kwalifikacji marki w celu znalezienia dostępnych dla niej przypadków użycia kampanii. Zasobów testowych nie można uznawać za kwalifikujące się do wysyłki produkcyjnej.

Opłaty produkcyjne

Aktualnie skonfigurowane opłaty za rejestrację marki
RejestracjaOpłata
Standardowa organizacja$5.00
Jednoosobowa działalność$4.45
Marka testowaBrak obciążenia za rejestrację marki w przepływie testowym

Te kwoty detaliczne sprawdzono względem aktualnej konfiguracji portalu w dniu 24 października 2026. Przed rejestracją produkcyjną potwierdź aktualną opłatę w portalu. Opłaty za kampanie, dodatkowa weryfikacja i zużycie wiadomości są rozliczane osobno. Rejestracja produkcyjna sprawdza uprawnienie do zakupu i dostępne środki przed przesłaniem; pomyślne utworzenie w rejestrze i lokalne rozliczenie to osobne etapy przetwarzania, dlatego zachowaj identyfikator zasobu i uzgodnij transakcje w razie błędu lub problemu z rozliczeniem.

Zmiana marki testowej na produkcyjną to osobno potwierdzany przepływ, który może utworzyć nową tożsamość produkcyjną i obciążenie. Nie zakładaj, że zmiana mock na false w późniejszym żądaniu przekształci istniejącą markę.

Obsługuj błędy bez duplikowania marki

Niepowodzenia rejestracji
Wynik HTTPCo sprawdzić
400Odczytaj błędy pól. Błędy walidacji rejestru mogą być tablicą obiektów code/description. Lokalna walidacja klucza idempotencji również może zwrócić 400.
401, 403 lub 404Sprawdź poświadczenia API, dozwolony źródłowy adres IP konta API, uprawnienia klienta i własność. Odpowiedź rejestru może też zawierać własny błąd autoryzacji.
402Sprawdź środki i uprawnienie do zakupu. Nie traktuj nieopłaconego żądania produkcyjnego jako testu w piaskownicy.
409Zachowaj ten sam klucz i niezmienione żądanie, czekając na żądanie w toku. Konflikt zmienionej treści/klucza lub niemożliwa do odzyskania wcześniejsza odpowiedź wymagają najpierw sprawdzenia rzeczywistego stanu i wyjaśnienia rozbieżności.
429 lub odpowiedź o niedostępności ogranicznikaRespektuj Retry-After, jeśli jest obecny. Ponów to samo zamierzone żądanie z tym samym kluczem po wygaśnięciu limitu.
500 lub 502Operacja zdalna mogła zostać zaakceptowana. Błąd przetwarzania lokalnego może zawierać requestId. Zapisz go i sprawdź istniejący zasób; nie zakładaj, że potrzebna jest zastępcza rejestracja.