Caricare i cataloghi per la registrazione della messaggistica

Caricare le opzioni prima di creare un modulo di registrazione

Usare il catalogo attuale per la registrazione della messaggistica per popolare le opzioni, anziché inserire nel codice valori fissi del registro. Per un modulo relativo a un marchio, il portale carica i cataloghi del tipo di attività, del settore, del tipo di identificativo aziendale alternativo, del rapporto con il marchio, del paese, dello stato degli Stati Uniti e della borsa valori. Per un modulo relativo a una campagna, carica i casi d'uso, i sottocasi d'uso validi e i partner di connettività. Conservare ogni valore restituito destinato all'elaborazione automatica insieme alla relativa etichetta visualizzata; quando si prepara una richiesta successiva, usare il valore, non un'etichetta tradotta.

Scegliere un catalogo

Gestire direttamente la risposta TCR

Il corpo della risposta proviene direttamente dall'API TCR. A differenza di molti endpoint precedenti /v3, non presenta un involucro aggiuntivo status/response. Controllare lo stato HTTP prima di interpretare la risposta. Un catalogo può contenere etichette testuali o definizioni strutturate, quindi non presumere che ogni valore abbia gli stessi campi. Se la richiesta HTTP riesce ma il corpo non è un documento JSON valido con la struttura prevista, segnalare il fallimento della ricerca anziché sostituirlo silenziosamente con un elenco vuoto.

Distinguere le opzioni dei cataloghi dall'idoneità e dai prezzi

Un catalogo generale dei casi d'uso non indica per quali casi d'uso sia idoneo un singolo marchio. Il portale attuale esegue una ricerca dell'idoneità specifica del marchio prima di creare una campagna e controlla i requisiti degli operatori selezionati. Analogamente, i metadati delle tariffe di un fornitore non rappresentano il prezzo finale al dettaglio applicato all'account. Esaminare separatamente il prezzo applicabile all'account e le condizioni di registrazione. Il caricamento di un catalogo non approva un marchio, una campagna o un numero per la messaggistica.

Gestire i cataloghi non disponibili

Conservare i dati inseriti dal cliente nel modulo se una ricerca fallisce. Mostrare l'errore, rispettare Retry-After quando viene restituito e aumentare progressivamente l'intervallo tra i tentativi. Non ricaricare ripetutamente tutti i cataloghi e non trattare un errore di limite delle richieste o di trasporto come un catalogo vuoto valido. Questa richiesta GET non richiede una chiave di idempotenza e non viene riprodotta dall'archivio di idempotenza delle operazioni di modifica.

Richiesta

Usare un account API abilitato tramite HTTPS da un indirizzo IP di origine consentito. La rotta attuale supporta la politica di autenticazione dell'account, inclusi l'autenticazione Basic e gli account API abilitati con autenticazione tramite token al portatore. Non usare le credenziali del fornitore.

Eseguire una richiesta GET con il nome di un catalogo supportato nel percorso. Passare i filtri applicabili al catalogo nella stringa di query. Non è necessario un corpo della richiesta.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/enum/usecase?validSubUsecase=true"

Risposta

Questa rotta TCR restituisce direttamente il corpo del registro con il relativo stato HTTP. Non usa il precedente involucro v3 status.code/status.msg/response. Le strutture dei cataloghi variano: alcuni associano i valori a oggetti descrittivi, altri a stringhe. Conservare le chiavi leggibili dalla macchina quando si invia un modulo successivo. L'esempio fittizio abbreviato di usecase illustra una mappa con valori costituiti da oggetti, non un catalogo in uso né uno schema di cui sia garantita la completezza. Controllare sia lo stato HTTP sia la struttura JSON prevista.

Struttura della risposta a scopo illustrativo; non contiene dati reali dell'account né un preventivo attuale.

{
  "2FA": {
    "displayName": "Authentication",
    "description": "Example authentication use case"
  }
}

Errori

• 401: Autenticazione dell'account non riuscita. Controllare la credenziale API, lo stato di abilitazione e le restrizioni applicabili all'indirizzo IP di origine.
• 400/404 e altri errori del registro: catalogo o filtro non valido o non disponibile. La rotta attuale conserva lo stato HTTP e il corpo della risposta del servizio a monte; non esiste un involucro universale degli errori v3.
• 429: Raggiunto il limite delle richieste dell'account o quello condiviso del fornitore. Rispettare Retry-After e riprovare aumentando progressivamente l'intervallo tra i tentativi.
• 502: Impossibile raggiungere il registro. La disponibilità è sconosciuta; non presentare un insieme vuoto di opzioni come risultato riuscito.
• 503: Il limitatore delle richieste o il servizio a monte non è disponibile. Esaminare il corpo e l'eventuale intestazione Retry-After prima di riprovare.

Disponibilità ed effetti collaterali

• Nel percorso esaminato, questa richiesta GET del catalogo non crea un marchio o una campagna, non invia una registrazione, non riserva una risorsa e non addebita una tariffa di registrazione. Contatta il fornitore e scrive registrazioni di controllo delle richieste.
• Le definizioni dei cataloghi e gli eventuali metadati delle tariffe del fornitore non costituiscono un preventivo al dettaglio per il cliente. Il portale attuale ottiene separatamente i prezzi al dettaglio delle campagne; la funzione ausiliaria precedente getCampaignPrice e le vecchie annotazioni dei prezzi delle enumerazioni non devono essere considerate il contratto tariffario di questa rotta.
• Una voce di catalogo supportata non dimostra che un determinato marchio sia idoneo per quel caso d'uso. Completare la verifica dell'idoneità specifica del marchio, le dichiarazioni, il consenso e l'esame dei prezzi dell'account prima di una successiva richiesta di registrazione.