Vai al contenuto principale
Questo documento introduce un’API di verifica dello stato del numero di telefono, che può essere utilizzata per convalidare lo stato di un numero di telefono, è possibile inserire il numero di telefono per effettuare la verifica.

Procedura di richiesta

Per utilizzare l’API, è necessario prima andare alla pagina corrispondente dell’API di verifica dello stato del numero di telefono per richiedere il servizio corrispondente, una volta entrati nella pagina, fare clic sul pulsante “Acquire”, come mostrato nell’immagine: Se non si è ancora effettuato il login o la registrazione, si verrà automaticamente reindirizzati alla pagina di login che invita a registrarsi e accedere, dopo aver effettuato il login o la registrazione si tornerà automaticamente alla pagina corrente. Alla prima richiesta, verrà fornito un credito gratuito, che consente di utilizzare gratuitamente l’API.

Utilizzo di base

Per prima cosa, è necessario comprendere il modo di utilizzo di base, ovvero inserire il numero di telefono per ottenere il risultato elaborato, è necessario semplicemente passare un campo mobile. Possiamo quindi compilare il contenuto corrispondente nell’interfaccia, come mostrato nell’immagine:

Si può notare che qui abbiamo impostato le intestazioni della richiesta, tra cui:
  • accept: il formato della risposta desiderata, qui è impostato su application/json, ovvero formato JSON.
  • authorization: la chiave per chiamare l’API, dopo la richiesta è possibile selezionarla direttamente dal menu a discesa.
Inoltre, abbiamo impostato il corpo della richiesta, tra cui:
  • mobile: il numero di telefono da elaborare, è un parametro obbligatorio.
  • encryption: opzionale, parametro di crittografia per campi sensibili (se è necessario inviare dati crittografati).
Dopo aver effettuato la selezione, si può notare che a destra è stato generato il codice corrispondente, come mostrato nell’immagine:

Cliccando sul pulsante “Try” è possibile effettuare un test, come mostrato nell’immagine sopra, qui abbiamo ottenuto il seguente risultato:
{
  "result": "0",
  "description": "Successo",
  "status_code": 0
}
Il risultato restituito ha diversi campi, descritti come segue:
  • result, codice del risultato di autenticazione, la situazione di addebito è la seguente.
    • Codici di risultato a pagamento:
      • 0: Successo
    • Codici di risultato non a pagamento:
      • -1: Nessun risultato trovato
      • -2: Formato del numero di telefono non corretto
      • -3: Servizio del centro di verifica occupato
  • description, descrizione del risultato commerciale.
  • status_code, codice di stato:
    • 0: Normale
    • 1: Disattivato
    • 2: Numero cancellato
    • 3: Numero non valido
    • 4: Non in rete
    • 99: Stato sconosciuto
Si può notare che lo stato di questo numero di telefono è stato già verificato. Inoltre, se si desidera generare il codice di integrazione corrispondente, è possibile copiarlo direttamente, ad esempio il codice CURL è il seguente:
curl -X POST 'https://api.acedata.cloud/identity/phone/check-1e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "mobile": "***"
}'
Il codice di integrazione in Python è il seguente:
import requests

url = "https://api.acedata.cloud/identity/phone/check-1e"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "mobile": "***"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)

Gestione degli errori

Quando si chiama l’API, se si verifica un errore, l’API restituirà il codice di errore e le informazioni corrispondenti. Ad esempio:
  • 400 token_mismatched: Richiesta non valida, probabilmente a causa di parametri mancanti o non validi.
  • 400 api_not_implemented: Richiesta non valida, probabilmente a causa di parametri mancanti o non validi.
  • 401 invalid_token: Non autorizzato, token di autorizzazione non valido o mancante.
  • 429 too_many_requests: Troppe richieste, hai superato il limite di frequenza.
  • 500 api_error: Errore interno del server, qualcosa è andato storto sul server.

Esempio di risposta di errore

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "fetch failed"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

Conclusione

Attraverso questo documento, hai appreso come utilizzare l’API di verifica dello stato del numero di telefono per convalidare lo stato di un numero di telefono, puoi inserire il numero di telefono per effettuare la verifica. Speriamo che questo documento possa aiutarti a integrare e utilizzare meglio l’API. Se hai domande, non esitare a contattare il nostro team di supporto tecnico.