Passer au contenu principal
Cet article présente une documentation sur l’API de vérification de l’état du numéro de téléphone, qui peut être utilisée pour valider l’état d’un numéro de téléphone. Vous pouvez entrer un numéro de téléphone pour effectuer la vérification.

​
Processus de demande

Pour utiliser l’API, vous devez d’abord vous rendre sur la page correspondante de l’API de vérification de l’état du numéro de téléphone pour demander le service correspondant. Une fois sur la page, cliquez sur le bouton « Acquire », comme indiqué sur l’image : Si vous n’êtes pas encore connecté ou inscrit, vous serez automatiquement redirigé vers la page de connexion pour vous inviter à vous inscrire et à vous connecter. Après vous être connecté ou inscrit, vous serez automatiquement renvoyé à la page actuelle. Lors de votre première demande, un quota gratuit sera offert, vous permettant d’utiliser l’API gratuitement.

​
Utilisation de base

Tout d’abord, comprenez la méthode d’utilisation de base, qui consiste à entrer un numéro de téléphone pour obtenir le résultat traité. Vous devez d’abord transmettre un champ mobile. Nous pouvons ensuite remplir le contenu correspondant sur l’interface, comme indiqué sur l’image :

Vous pouvez voir ici que nous avons défini les en-têtes de requête, y compris :
  • accept : le format de réponse souhaité, ici rempli avec application/json, c’est-à-dire au format JSON.
  • authorization : la clé d’API pour appeler l’API, que vous pouvez sélectionner directement après la demande.
De plus, nous avons défini le corps de la requête, y compris :
  • mobile : le numéro de téléphone à traiter, c’est un paramètre obligatoire.
  • encryption : optionnel, paramètre de cryptage pour les champs sensibles (si vous devez envoyer des données chiffrées).
Après avoir fait votre sélection, vous pouvez constater que le code correspondant a également été généré à droite, comme indiqué sur l’image :

Cliquez sur le bouton « Try » pour effectuer un test, comme indiqué sur l’image ci-dessus, et nous avons obtenu le résultat suivant : 
{
  "result": "0",
  "description": "Succès",
  "status_code": 0
}
Le résultat retourné contient plusieurs champs, décrits comme suit :
  • result, code de résultat de l’authentification, les frais sont les suivants.
    • Codes de résultat payants :
      • 0 : Succès
    • Codes de résultat non payants :
      • -1 : Aucun résultat trouvé
      • -2 : Format de numéro de téléphone incorrect
      • -3 : Service du centre de validation occupé
  • description, description du résultat commercial.
  • status_code, code d’état :
    • 0 : Normal
    • 1 : Hors service
    • 2 : Numéro résilié
    • 3 : Numéro inactif
    • 4 : Non sur le réseau
    • 99 : État inconnu
On peut voir que l’état de ce numéro de téléphone a été vérifié. De plus, si vous souhaitez générer le code d’intégration correspondant, vous pouvez le copier directement, par exemple, le code CURL est le suivant : 
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": "***"
}'
Le code d’intégration Python est le suivant : 
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)

​
Gestion des erreurs

Lors de l’appel de l’API, si une erreur se produit, l’API renverra le code d’erreur et les informations correspondantes. Par exemple :
  • 400 token_mismatched : Mauvaise requête, probablement en raison de paramètres manquants ou invalides.
  • 400 api_not_implemented : Mauvaise requête, probablement en raison de paramètres manquants ou invalides.
  • 401 invalid_token : Non autorisé, jeton d’autorisation invalide ou manquant.
  • 429 too_many_requests : Trop de requêtes, vous avez dépassé la limite de taux.
  • 500 api_error : Erreur interne du serveur, quelque chose s’est mal passé sur le serveur.

​
Exemple de réponse d’erreur

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "échec de la récupération"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

​
Conclusion

Grâce à ce document, vous avez compris comment utiliser l’API de vérification de l’état du numéro de téléphone pour valider l’état d’un numéro de téléphone. Vous pouvez entrer un numéro de téléphone pour effectuer la vérification. Nous espérons que ce document vous aidera à mieux intégrer et utiliser cette API. Si vous avez des questions, n’hésitez pas à contacter notre équipe de support technique.