Documentation API

Méthode: test

Cette méthode est utilisée pour tester la connexion à l’API. Elle vérifie que votre clé API est valide et que le service est accessible. Si tout est correctement configuré, l’API renverra une réponse réussie.

Exemple de requête

{
    "method": "test"
}

Réponse réussie

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

Champs de réponse
error — code d’erreur (0 signifie que la requête a réussi)
message — message de réponse de l’API

Méthode: info

La méthode info retourne des informations sur votre compte et votre abonnement actuel, y compris le nombre de requêtes API utilisées.

Exemple de requête

{
    "method": "info"
}

Réponse réussie

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

Champs de réponse
error — code d’erreur (0 signifie que la requête a réussi)
name — prénom du propriétaire du compte
surname — nom du propriétaire du compte
email — adresse email du compte
subscription — plan d’abonnement actuel
count_request — nombre de requêtes API utilisées dans la période d’abonnement actuelle

Méthode: verify

La méthode verify vérifie un numéro de téléphone et renvoie des informations de validation détaillées.

Les numéros de téléphone peuvent être fournis dans n’importe quel format. L’API gère automatiquement des caractères tels que (, ), -, + et les espaces.

Exemple de requête

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

Réponse réussie

{
  "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
  }
}

Champs de réponse
error — code d’erreur (0 signifie que la requête a réussi)
request_phone — numéro de téléphone envoyé dans la requête
valid_phone — résultat de validation (true si le numéro est valide)
type — type de numéro de téléphone (ex. mobile, fixe, etc.)

Objet Format
local — numéro de téléphone au format local
international — numéro de téléphone au format international

Objet Pays
code — code pays ISO
name — nom du pays
prefix — préfixe téléphonique international

Objet Requêtes
Informations sur l’utilisation actuelle de votre abonnement.
subscription — plan d’abonnement actif
count — nombre de requêtes déjà utilisées
start — date de début de la période d’abonnement
finish — date de fin de la période d’abonnement
limit — nombre maximum de requêtes autorisées dans la période d’abonnement