Sviluppatori

GET/v3/getcountries

Elenca i paesi con numeri disponibili

Restituisce i paesi visibili che attualmente hanno almeno un prefisso con numeri disponibili. Ogni voce include il prefisso internazionale, il codice ISO, gli indicatori nazionali per numeri mobili e SMS, le coordinate e un collegamento next_function alle aree del paese.

Su questa pagina
  1. Richiesta
  2. Risposta
  3. Errori
  4. Disponibilità ed effetti collaterali

Inizia da qui la ricerca dei numeri locali. L'elenco contiene solo i paesi che attualmente hanno numeri disponibili. Non viene effettuata alcuna prenotazione.

  • Passa isocode a getareas, a getstates (solo US e CA) oppure a other.
  • next_function rimanda sempre a v3/getareas/{isocode}. Per gli Stati Uniti e il Canada, puoi chiamare getstates prima, per restringere la ricerca a uno stato o a una provincia.
  • is_mobile e sms_coverage sono indicatori a livello nazionale e non costituiscono garanzie per ogni numero. Per gli Stati Uniti, is_mobile è 0 a meno che il tuo account non sia abilitato ai numeri mobili degli Stati Uniti.
  • I paesi con copertura disponibile esclusivamente su ordinazione non sono elencati. Puoi comunque chiamare getareas oppure other direttamente per un paese che non compare nell'elenco.
  • Ordina autonomamente l'elenco se hai bisogno di un ordine specifico.

Se nessun paese soddisfa i criteri, response è null e status.code è 200.

Richiesta

Obbligatorio: autenticazione HTTP Basic oppure token Bearer (vedi Autenticazione e risposte API). Se l'autenticazione non riesce, viene restituita una risposta HTTP 401 prima di eseguire la ricerca.

GET senza corpo. L'unico parametro è pid, facoltativo e inviato nella stringa di query.

curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/getcountries'
Parametri di query
NomeTipoObbligatorioDescrizione
pidstringNoAvanzato e facoltativo. Restringe l'elenco ai paesi contrassegnati per una specifica fonte di disponibilità. Usa solo un valore fornito da MultiTEL, in formato numerico o esadecimale di 32 caratteri, e omettilo per l'uso normale. pid non restringe la verifica della disponibilità descritta nella risposta. I valori non riconosciuti, lo zero e i valori non accettati da questo endpoint vengono ignorati senza generare errori; in tal caso l'elenco comprende tutte le fonti supportate.

Risposta

Struttura standard della risposta. In caso di successo, status.code è 200, status.msg è 'Results: N', status.results è N e response è un elenco di paesi senza un ordine garantito. Campi: countrycode (prefisso internazionale del paese senza '+'); name (nome del paese); description (stesso valore di name); isocode (codice ISO 3166-1 alpha-2); is_mobile (0 o 1, indicatore di catalogo a livello nazionale, sempre 0 per US a meno che il tuo account non sia abilitato ai numeri mobili di US); sms_coverage (0 o 1, indicatore di catalogo a livello nazionale); latitude e longitude (coordinate del paese); next_function ('v3/getareas/{isocode}'). Un paese viene elencato solo se è visibile e almeno uno dei suoi prefissi dispone attualmente di numeri presso una qualsiasi fonte di disponibilità. I paesi la cui copertura è interamente su ordinazione (senza numeri disponibili) non sono elencati. Questa verifica della disponibilità è più ampia dei filtri applicati da getareas, quindi un paese elencato può occasionalmente restituire 'No areas found' in tale chiamata. Se nessun paese soddisfa i criteri, status.code è 200, status.msg è 'Results: 0', il campo status.results è assente e response è null.

Esempio illustrativo della struttura della risposta; non contiene dati reali dell'account né un preventivo attuale.

{
  "status": {
    "code": 200,
    "msg": "Results: 2",
    "results": 2
  },
  "response": [
    {
      "countrycode": "1",
      "name": "United States",
      "description": "United States",
      "isocode": "US",
      "is_mobile": 0,
      "sms_coverage": 1,
      "latitude": "38.0000",
      "longitude": "-97.0000",
      "next_function": "v3/getareas/US"
    },
    {
      "countrycode": "44",
      "name": "United Kingdom",
      "description": "United Kingdom",
      "isocode": "GB",
      "is_mobile": 1,
      "sms_coverage": 0,
      "latitude": "54.0000",
      "longitude": "-2.0000",
      "next_function": "v3/getareas/GB"
    }
  ]
}

Errori

  • 401: autenticazione assente o non riuscita. Inviato con stato HTTP 401 (vedi Autenticazione e risposte API).

Disponibilità ed effetti collaterali

  • Solo consultazione. Non prenota, ordina o modifica nulla.
  • I risultati riflettono la disponibilità al momento della richiesta e possono cambiare tra una chiamata e l'altra.