Seleziona un marchio già presente nel tuo account
Parti dall'ID del marchio nel registro già associato al tuo account MultiTEL. Questa consultazione non crea un marchio e non associa al tuo account il marchio di un altro soggetto. L'attuale procedura per i clienti verifica la titolarità prima di richiedere le informazioni sull'idoneità. Se la consultazione restituisce 404, verifica l'account e il marchio selezionati anziché sostituire l'identificativo con quello di una riga locale.
Ricava da questo risultato i casi d'uso selezionabili
Il catalogo generale dei casi d'uso descrive le opzioni del registro. Questa consultazione specifica per marchio fornisce le opzioni per il marchio selezionato. Conserva ogni valore di usecase restituito e abbinalo all'etichetta di visualizzazione e alla descrizione del catalogo. Non proporre tutte le voci del catalogo generale come se il marchio fosse idoneo per ciascuna di esse.
Il portale si aspetta che questa risposta sia un elenco JSON. Se la risposta manca, è malformata o contiene un errore, conserva il modulo del cliente e indica che non è stato possibile caricare le informazioni sull'idoneità. Non interpretarla implicitamente come un'approvazione per un caso d'uso predefinito. Il registro può restituire campi ulteriori rispetto a quelli dell'esempio abbreviato.
Carica i requisiti per il caso d'uso selezionato
Dopo che un cliente ha scelto uno dei valori di caso d'uso restituiti, invia una richiesta a /tcr/v2/campaignBuilder/brand/{brand_id}/usecase/{usecase} per lo stesso marchio. La risposta fornisce i limiti relativi ai sottocasi d'uso e i requisiti specifici degli operatori. Usala per raccogliere esempi di messaggi, consenso e altre dichiarazioni obbligatorie. Il solo elenco di idoneità non basta per predisporre una registrazione completa della campagna.
Esamina separatamente le tariffe dell'account
I campi del fornitore come monthlyFee, quarterlyFee o annualFee, quando vengono restituiti, descrivono metadati sulle commissioni del fornitore. Non sostituiscono le tariffe dell'account del cliente né le condizioni di registrazione. Il portale attuale legge separatamente le tariffe al dettaglio delle campagne e le combina con i dati di idoneità nella schermata di riepilogo. Non dedurre un addebito al cliente dalle tariffe codificate direttamente nel vecchio componente di supporto per le enumerazioni.
Aggiorna i dati quando cambia il marchio o il caso d'uso
Quando cambi marchio, elimina le opzioni del marchio precedente e carica le informazioni sull'idoneità per la nuova selezione. Aggiorna i requisiti del caso d'uso selezionato prima dell'invio. Queste richieste GET non inviano una registrazione, non attivano una campagna e non assegnano numeri.
Richiesta
Usa un account API abilitato tramite HTTPS, da un indirizzo IP di origine consentito. La rotta attuale supporta i criteri di autenticazione dell'account, compresa l'autenticazione Basic e gli account API abilitati all'autenticazione tramite token bearer. Non usare le credenziali del fornitore.
GET con l'identificativo del marchio nel percorso dell'URL. Non è richiesto un corpo della richiesta.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID"| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
brand_id | stringa | Sì | L'ID del marchio nel registro associato al tuo account MultiTEL autenticato. Usa l'ID del marchio, non l'ID di una riga del database locale, l'ID di una campagna o il codice fiscale dell'impresa. Codificalo come un unico segmento del percorso dell'URL. |
Risposta
La rotta TCR attuale restituisce direttamente il corpo JSON del registro e ne conserva lo stato HTTP. Non aggiunge l'involucro status/response della versione precedente v3. L'esempio fittizio abbreviato non è un risultato effettivo di verifica dell'idoneità. Prima di usarlo, verifica lo stato HTTP e la struttura JSON prevista. Il portale attuale si aspetta un elenco di record di idoneità, ciascuno dei quali identifica un usecase. Combina questi record con il catalogo usecase per le etichette di visualizzazione e legge separatamente le tariffe al dettaglio. Possono essere presenti ulteriori campi del fornitore.
Struttura di risposta a scopo illustrativo; non contiene dati effettivi dell'account né un preventivo attuale.
[
{
"usecase": "2FA"
}
]Errori
- 401: Autenticazione dell'account non riuscita. Verifica le credenziali API, lo stato di abilitazione e le restrizioni applicabili agli IP di origine.
- 404: Il marchio non è associato all'account autenticato oppure il fornitore non riesce a trovare il marchio o la selezione richiesti. Se la verifica locale della titolarità dà esito negativo, viene restituito un rifiuto prima di inviare una richiesta al fornitore.
- Altri errori del registro: vengono conservati lo stato HTTP e il corpo restituiti dal servizio a monte. Un caso d'uso non valido o non disponibile non equivale a un insieme vuoto di requisiti ottenuto con successo.
- 429: Raggiunto il limite di richieste dell'account o quello condiviso del fornitore. Rispetta Retry-After.
- 502/503: Errore di trasporto o indisponibilità del fornitore o del limitatore di frequenza delle richieste. Conserva il modulo e riprova aumentando progressivamente l'intervallo tra i tentativi.
Disponibilità ed effetti collaterali
- La richiesta GET esaminata verifica la titolarità del marchio esistente, contatta il registro e scrive record di audit delle richieste. Non crea un marchio o una campagna e non addebita commissioni di registrazione.
- I metadati sulle commissioni del fornitore non costituiscono un preventivo al dettaglio per il cliente MultiTEL. Il portale esamina separatamente le tariffe dell'account prima di una successiva richiesta di registrazione.
- L'idoneità e i requisiti possono cambiare. Aggiornali per il marchio e il caso d'uso selezionati prima dell'invio. Una consultazione riuscita non costituisce un'approvazione della campagna, un'assegnazione di numeri o un'autorizzazione a iniziare l'invio di messaggi.