Prima di iniziare
Scegli un'area tramite getareas. Copia l'ID dell'area dalla risposta o dal valore restituito di next_function. Per un'area degli Stati Uniti o del Canada, usa getstates se vuoi limitare i risultati a un solo stato o a una sola provincia.
Leggere il risultato
Controlla status.code nel corpo JSON, oltre allo stato HTTP. I risultati delle richieste riuscite si trovano nell'array response. La risposta predefinita è ordinata per nome. available è una stima e gli indicatori del catalogo non sostituiscono la verifica delle funzionalità effettive del numero selezionato e dei requisiti di registrazione.
Scegliere il passaggio successivo
Usa un risultato non raggruppato. Quando returns_numbers è 1, il valore restituito di next_function rimanda a una ricerca di numeri. Quando è 0, i numeri vengono assegnati al momento dell'ordine e il percorso rimanda a un'operazione di ordinazione. Esamina l'operazione e i relativi requisiti prima di inviare la richiesta: una richiesta di ordinazione può comportare un addebito sul tuo account. Non inviare automaticamente richieste a tutti i percorsi restituiti.
Qui non è incluso alcun prezzo. Prima dell'acquisto, esamina il preventivo pertinente, i documenti richiesti e le istruzioni per l'ordine. Conserva gli ID restituiti del singolo prefisso e del preventivo, anziché ricavarli da un prefisso telefonico visualizzato.
Opzioni avanzate di visualizzazione
compact=1 restituisce un campione in ordine casuale di al massimo 100 righe, non una pagina di un insieme di risultati più ampio. Il raggruppamento crea righe riepilogative e ID sintetici; usa una normale risposta non raggruppata per selezionare un singolo prefisso. Non usare risultati campionati o raggruppati per affermare che l'inventario sia completo o che le funzionalità siano esatte.
Richiesta
Usa le credenziali del tuo account API abilitato tramite HTTPS. Sono supportati l'autenticazione Basic e i token bearer abilitati per l'account API; si applicano le restrizioni dell'account.
Usa GET e invia i parametri facoltativi nella stringa di query. Non fare affidamento sull'uso del corpo del modulo come alternativa.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/v3/getprefixes/$AREA_ID?state=NY"| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
area_id | string | Sì | Copia l'identificatore dell'area da getareas o dal relativo next_function. Trattalo come un valore opaco; non costruirlo né calcolarne un hash autonomamente. |
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
state | string | No | Solo per le aree di US e CA. Usa un codice di stato o provincia ottenuto da getstates, oppure il nome completo dello stato o della provincia. Per i codici non si distingue tra maiuscole e minuscole; per i nomi si ignorano le differenze tra maiuscole e minuscole e gli spazi ripetuti. Un altro paese o un valore non vuoto non riconosciuto restituisce un errore API. |
compact | string | No | Modalità di campionamento facoltativa: 1, true o on. I risultati sono in ordine casuale, con al massimo 100 righe. Ometti questo parametro per ottenere l'elenco completo dei risultati; questo endpoint non prevede pagine né cursori. |
group | integer | No | Riepiloghi avanzati per la visualizzazione: i valori da 1 a 6 combinano le righe e restituiscono prefissi mascherati da visualizzare. Gli UUID dei gruppi sono sintetici e non sono intercambiabili con gli ID dei singoli prefissi. Effettua una richiesta senza raggruppamento prima di selezionare un prefisso per una ricerca di numeri o un ordine. Ometti questo parametro per il normale flusso di lavoro. |
pid | string | No | Selettore facoltativo dell'inventario fornito da MultiTEL, in formato numerico o nel formato esadecimale supportato a 32 caratteri. Omettilo per l'uso normale. I valori non riconosciuti vengono ignorati senza segnalazioni. Il valore non è un prefisso telefonico né l'ID di un piano tariffario. |
Risposta
La struttura JSON standard status/response. status.results conta le righe restituite, anche in caso di campionamento o raggruppamento. response contiene gli oggetti dei prefissi. Non vengono restituiti campi relativi ai prezzi. Nella normale risposta non raggruppata, uuid è l'ID del prefisso; area_uuid e country_uuid sono identificatori restituiti; prefix e name sono informazioni da visualizzare; available è una stima della disponibilità, non una prenotazione; needs_registration e restrictions descrivono informazioni sulla registrazione; sms_coverage, is_mobile e number_type sono indicazioni del catalogo e non garantiscono una specifica funzionalità di un numero. number_type può essere vuoto o contenere un'altra stringa del catalogo, quindi non imporre un insieme fisso di valori enumerati. state è una stringa e può essere vuota o contenere formattazione del catalogo. latitude e longitude possono essere vuoti. metered e overflow sono indicatori del catalogo, non importi monetari. returns_numbers seleziona un percorso per elencare i numeri (1) o un percorso per l'assegnazione al momento dell'ordine (0). next_function identifica tale percorso successivo. Le risposte raggruppate contengono inoltre caratteristiche aggregate, compresi valori di ripiego per le caratteristiche; non interpretarli come funzionalità verificate di ogni numero.
Struttura di risposta a scopo illustrativo; non rappresenta dati dell'account in tempo reale né un preventivo attuale.
{
"status": {
"code": 200,
"msg": "",
"results": 1
},
"response": [
{
"uuid": "PREFIX_ID_FROM_RESPONSE",
"area_uuid": "AREA_ID_FROM_RESPONSE",
"country_uuid": "COUNTRY_ID_FROM_RESPONSE",
"prefix": "+1212",
"name": "Example area",
"metered": 0,
"overflow": 0,
"needs_registration": 0,
"restrictions": "",
"state": "NY",
"country_iso": "US",
"is_mobile": 0,
"number_type": "local",
"latitude": "",
"longitude": "",
"available": 12,
"sms_coverage": 1,
"returns_numbers": 1,
"next_function": "v3/getnumbers/PREFIX_ID_FROM_RESPONSE"
}
]
}Errori
- 404: Invalid area ID: ottieni un ID di area aggiornato tramite le operazioni di consultazione del catalogo.
- 404: State filter is only available for US and CA: ometti state per gli altri paesi.
- 404: Invalid state: usa uno stato o una provincia restituiti da getstates per questo paese.
- 404: No prefixes found: non è stata restituita alcuna riga del catalogo corrispondente ai criteri. Questo non dimostra che un determinato numero non possa mai essere ordinato.
- 500: Errore: 'Failed loading prefixes': la consultazione del catalogo non è riuscita. Riprova più tardi e contatta l'assistenza se il problema persiste.
Disponibilità ed effetti collaterali
- Questo è un passaggio di consultazione del catalogo, non una conferma d'ordine. La disponibilità può essere aggiornata tramite ulteriori consultazioni del catalogo, quindi il tempo di risposta può variare.
- I prezzi non vengono restituiti. Recupera il preventivo applicabile al numero o all'ordine ed esamina i requisiti di registrazione prima di effettuare un ordine.
- Non considerare available come un conteggio preciso delle scorte, lo zero come un divieto assoluto di ordinare o una consultazione riuscita come una prenotazione. La disponibilità può cambiare prima dell'ordine.