Documentazione API

Metodo: test

Questo metodo viene utilizzato per testare la connessione API. Verifica che la tua chiave API sia valida e che il servizio sia raggiungibile. Se tutto è configurato correttamente, l’API restituirà una risposta di successo.

Esempio di richiesta

{
    "method": "test"
}

Risposta di successo

{
  "error": 0,
  "message": "Yippee-ki-yay"
}

Campi della risposta
error — codice di errore (0 significa che la richiesta è stata eseguita con successo)
message — messaggio di risposta dall’API

Metodo: info

Il metodo info restituisce informazioni sul tuo account e sull’abbonamento corrente, incluso il numero di richieste API utilizzate.

Esempio di richiesta

{
    "method": "info"
}

Risposta di successo

{
    "error": 0,
    "name": "John",
    "surname": "Smith",
    "email": "[email protected]",
    "subscription": "Growth",
    "count_request": 2349
}

Campi della risposta
error — codice di errore (0 significa che la richiesta è stata eseguita con successo)
name — nome del proprietario dell’account
surname — cognome del proprietario dell’account
email — indirizzo email dell’account
subscription — piano di abbonamento corrente
count_request — numero di richieste API utilizzate nel periodo di abbonamento corrente

Metodo: verify

Il metodo verify controlla un numero di telefono e restituisce informazioni dettagliate di validazione.

I numeri di telefono possono essere forniti in qualsiasi formato. L’API gestisce automaticamente caratteri come (, ), -, + e spazi.

Esempio di richiesta

{
  "phone": "491609502065",
  "method": "verify"
}

Risposta di successo

{
  "error": 0,
  "request_phone": "491609502065",
  "valid_phone": true,
  "type": "mobile",
  "format": {
    "local": "01609502065",
    "international": "+491609502065"
  },
  "country": {
    "code": "DE",
    "name": "Germany (Federal Republic of)",
    "prefix": "+49"
  },
  "requests": {
    "subscription": "Growth",
    "count": 2,
    "start": "2026-04-06 10:29:40",
    "finish": "2026-10-06 10:29:40",
    "limit": 9000
  }
}

Campi della risposta
error — codice di errore (0 significa che la richiesta è stata eseguita con successo)
request_phone — numero di telefono inviato nella richiesta
valid_phone — risultato della validazione (true se il numero è valido)
type — tipo di numero di telefono (es. mobile, fisso, ecc.)

Oggetto Format
local — numero di telefono in formato locale
international — numero di telefono in formato internazionale

Oggetto Country
code — codice paese ISO
name — nome del paese
prefix — prefisso internazionale di chiamata

Oggetto Requests
Informazioni sull’utilizzo corrente del tuo abbonamento.
subscription — piano di abbonamento attivo
count — numero di richieste già utilizzate
start — data di inizio del periodo di abbonamento
finish — data di fine del periodo di abbonamento
limit — numero massimo di richieste consentite nel periodo di abbonamento