Sviluppatori

POST/tcr/v2/brand/nonBlocking

Registrare un brand di messaggistica

Registra un'identità aziendale di proprietà dell'account, mantieni esplicite le richieste sandbox e riconcilia validazione e costi.

Su questa pagina
  1. Registra l'azienda dietro i tuoi messaggi
  2. Inizia con una richiesta sandbox esplicita
  3. Campi aziendali e di contatto
  4. Mantieni una chiave di idempotenza stabile
  5. Leggi il brand e il suo stato
  6. Costi di produzione
  7. Gestisci gli errori senza duplicare il brand

Registra l'azienda dietro i tuoi messaggi

Un brand di messaggistica identifica l'azienda che invia messaggi 10DLC negli Stati Uniti. Registra il brand prima di scegliere un caso d'uso per la campagna. Usa i dati legali dell'azienda e un contatto in grado di completare qualsiasi validazione richiesta. Un ID brand restituito non costituisce, di per sé, l'approvazione a inviare messaggi.

Usa questa route attuale di proprietà dell'account tramite HTTPS con un account API abilitato e il relativo indirizzo IP di origine consentito. Non inviare user_id, username né l'identificatore proprietario di un altro cliente. MultiTEL registra la proprietà a partire dall'account autenticato.

Inizia con una richiesta sandbox esplicita

Il portale imposta per impostazione predefinita il campo mode del proprio modulo su sandbox; una richiesta diretta all'API deve includere esplicitamente il booleano JSON mock: true quando intendi creare un brand fittizio. Omettere quel flag non garantisce la sandbox e può creare una registrazione di produzione addebitabile. Il campo mode del portale non sostituisce il campo mock dell'API.

Prepara un file brand.json locale usando i campi seguenti. Sostituisci i segnaposto con dati di test appropriati e codici di catalogo attuali. Questo esempio è un'azienda privata a scopo di lucro; altri tipi di entità hanno requisiti diversi.

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

L'azienda, l'indirizzo, il telefono e l'identificatore riportati sopra sono segnaposto, non un'identità aziendale pronta per la registrazione. Ottieni i valori attuali di entityType, vertical, country, state, brandRelationship e delle altre enumerazioni dai cataloghi di messaggistica.

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'

Campi aziendali e di contatto

Campi di registrazione del brand
CampiCosa fornire
entityType, displayNameCodice attuale del tipo di entità e nome riconoscibile del brand. Le lunghezze massime sono rispettivamente 20 e 255 caratteri.
country, street, city, state, postalCodeL'indirizzo effettivo dell'azienda. Usa il codice paese di due lettere e un codice state statunitense attuale, se applicabile. Limiti: street 255, city 100, state 20 e postalCode 10 caratteri.
email, phoneUn'e-mail di contatto funzionante, fino a 100 caratteri, e un numero di telefono in formato internazionale con +prefisso paese, fino a 20 caratteri. Mantieni i dati aziendali coerenti in tutta la registrazione.
companyName, ein, einIssuingCountryPer le organizzazioni, fornisci la ragione sociale legale e l'identificativo fiscale dell'azienda. Il paese che ha emesso l'identificativo è un campo separato di due lettere. Limiti: companyName 255 e ein 21 caratteri. Una ditta individuale usa i campi del nome personale al posto dell'identità fiscale di un'organizzazione.
brandRelationship, verticalIl rapporto con l'azienda e il suo settore, usando i codici di catalogo attuali. Le organizzazioni li richiedono; le regole per le ditte individuali sono diverse. Non sostituire i codici API con etichette di visualizzazione tradotte.
firstName, lastName, mobilePhoneObbligatori per una ditta individuale. I campi del nome consentono fino a 100 caratteri ciascuno. Fornisci un numero di cellulare idoneo per la validazione OTP obbligatoria, in formato internazionale.
stockSymbol, stockExchange, website, businessContactEmailUna società quotata necessita anche del proprio simbolo/borsa azionaria, di website e di un'e-mail di contatto aziendale idonea per il processo di validazione aggiuntivo. Limiti: stockSymbol 10, website 255 e businessContactEmail 255 caratteri.
altBusinessIdType, altBusinessIdIdentificatore aziendale alternativo facoltativo. Fornisci insieme il tipo e il valore. Usa il catalogo dei tipi attuale; il valore consente fino a 50 caratteri.
referenceIdIl tuo riferimento aziendale, fino a 50 caratteri. Includilo nella registrazione di una ditta individuale secondo i requisiti attuali specifici dell'entità. Si tratta di metadati aziendali, non della chiave di idempotenza della richiesta.
website, ipAddress, tagSito web aggiuntivo, metadati dell'IP di origine e valori di tag, se applicabili. Questi non stabiliscono la proprietà dell'account né sostituiscono i controlli di identità.
mockUn booleano JSON. Usa true solo per il flusso di lavoro fittizio previsto; usa false per una registrazione di produzione esplicitamente verificata. Non inviare la stringa "false" al posto di un booleano JSON.

Le ditte individuali sono supportate per registrazioni negli Stati Uniti o in Canada e richiedono la verifica OTP prima dell'idoneità alle campagne. Le società quotate possono richiedere un passaggio di validazione del contatto aziendale. GOVERNMENT è riservato alle entità governative con sede negli Stati Uniti; verifica la categoria di entità corretta per le altre organizzazioni. Segui i requisiti specifici dell'entità oltre agli errori di validazione restituiti.

Mantieni una chiave di idempotenza stabile

Genera una sola Idempotency-Key per questa registrazione prevista. Deve contenere 1–128 caratteri ASCII stampabili senza spazi. Riutilizza la stessa chiave solo con lo stesso metodo HTTP, lo stesso percorso, la stessa query string e gli stessi identici byte del corpo della richiesta. Riformattare il JSON, anche senza cambiarne il significato, cambia l'impronta della richiesta.

Una richiesta con chiave già completata può riprodurre la risposta memorizzata senza un nuovo invio della registrazione. Un duplicato ancora in elaborazione restituisce HTTP 409 e può includere Retry-After. Una richiesta modificata con la stessa chiave genera un conflitto. Non generare una nuova chiave solo perché una richiesta è scaduta o ha restituito un errore: l'azienda potrebbe essere già stata registrata.

Mantieni brand.json invariato mentre risolvi quella richiesta. Un 500 o 502 memorizzato nella cache può riprodurre l'errore originale anziché ripetere la registrazione. Conserva qualsiasi brandId, requestId e intestazione di correlazione restituiti; riconcilia il brand esistente prima di avviare una richiesta diversa.

Leggi il brand e il suo stato

Questa API usa i codici di stato HTTP e un corpo JSON diretto, anziché l'envelope status/response della v3. Una registrazione riuscita restituisce un oggetto brand che include brandId. Conserva quell'identificatore e controlla lo stato di validazione o di identità restituito. I campi aggiuntivi dipendono dall'entità e dallo stato della registrazione.

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

Leggi solo un brand appartenente al tuo account. Un 404 può significare che il brand non è disponibile per questo account. Completa qualsiasi validazione richiesta, poi usa la qualificazione del brand per trovare i suoi casi d'uso di campagna disponibili. Non si può presumere che le risorse fittizie siano idonee all'invio in produzione.

Costi di produzione

Costi di registrazione del brand attualmente configurati
RegistrazioneCosto
Organizzazione standard$5.00
Ditta individuale$4.45
Brand fittizioNessun addebito per la registrazione del brand nel flusso di lavoro fittizio

Questi importi al dettaglio sono stati verificati rispetto alla configurazione attuale del portale il 24 ottobre 2026. Conferma il costo attuale nel portale prima della registrazione di produzione. Gli addebiti per le campagne, la verifica aggiuntiva e l'utilizzo della messaggistica sono separati. Una registrazione di produzione controlla il permesso di acquisto e i fondi disponibili prima dell'invio; la creazione riuscita nel registro e la fatturazione locale sono passaggi di elaborazione separati, quindi conserva l'ID della risorsa e riconcilia le transazioni se si verifica un errore o un problema di fatturazione.

Trasformare un brand fittizio in produzione è un flusso di lavoro confermato separatamente e può creare una nuova identità di produzione e un nuovo addebito. Non presumere che modificare mock in false in una richiesta successiva converta il brand esistente.

Gestisci gli errori senza duplicare il brand

Errori di registrazione
Risultato HTTPCosa controllare
400Leggi gli errori dei campi. Gli errori di validazione del registro possono essere un array di oggetti code/description. Anche la validazione locale della chiave di idempotenza può restituire 400.
401, 403 o 404Controlla le credenziali API, l'IP di origine consentito dell'account API, i permessi del cliente e la proprietà. Una risposta del registro può anche contenere un proprio errore di autorizzazione.
402Verifica i fondi e il permesso di acquisto. Non trattare una richiesta di produzione priva di fondi come un test sandbox.
409Mantieni la stessa chiave e la richiesta invariata mentre attendi una richiesta in corso. Un conflitto per corpo/chiave modificati o una risposta precedente irrecuperabile richiede prima una riconciliazione.
429 o una risposta di limitatore non disponibileRispetta Retry-After quando presente. Ripeti la stessa richiesta prevista e la stessa chiave dopo che il limite è stato rimosso.
500 o 502L'operazione remota potrebbe essere stata accettata. Un errore di elaborazione locale può includere requestId. Salvalo e controlla la risorsa esistente; non presumere che sia necessaria una registrazione sostitutiva.