Obtenir la liste de vos demandes | Documentation (en anglais) | API de vérification en masse des e-mails | WhoisXML API

Obtenir une liste de vos demandes

POST https://emailverification.whoisxmlapi.com/api/bevService/request/list

Exemple de requête CURL

curl https://emailverification.whoisxmlapi.com/api/bevService/request/list -X POST -H "Content-Type: application/json"  -d '{"apiKey": "YOUR_API_KEY", "page": 1, "onlyIds": false, "perPage": 10, "sort": "desc", "format": "json"}'

Exemple de corps de requête POST

{
    "apiKey": "YOUR_API_KEY",
    "page": 1,
    "format": "json",
    "onlyIds": false,
    "perPage": 10,
    "sort": "desc"
}

Paramètres d'entrée

apiKey

Nécessaire. Obtenez votre clé API personnelle sur la page Mes produits.

page

Facultatif. Integer.

Utilisé pour paginer les jeux de résultats en conjonction avec 'perPage'.

Valeur par défaut : 1.

onlyIds

Facultatif. Boolean.

Lorsque la valeur est 'true', seule la liste des ID est renvoyée.

Valeur par défaut : true.

perPage

Facultatif. Integer.

Limite chaque page du jeu de résultats à ce nombre de requêtes.

Min : 10 ; Max : 50.

Valeur par défaut : 10

sort

Facultatif. string.

Spécifiez l’ordre des demandes dans la réponse.

Valeurs autorisées : « asc », « desc ».

Valeur par défaut : « desc ».

format

Facultatif. string.

Permet de spécifier le format de réponse.

Valeurs autorisées : « xml », « json », « csv ».

Valeur par défaut : « json ».

Exemple de sortie

{
    "response": {
        "current_page": 1,
        "data": [
            {
                "id": 596
            },
            {
                "id": 595
            },
            {
                "id": 544
            }
        ],
        "from": 1,
        "last_page": 1,
        "per_page": 10,
        "to": 3,
        "total": 3
    }
}

Code: 200 OK.
{
    "response": {
        "current_page": 1,
        "data": [
            {
                "id": 596,
                "api_version": 3,
                "date_start": "1528377253",
                "total_emails": 3,
                "invalid_emails": 0,
                "processed_emails": 3,
                "failed_emails": 0,
                "ready": 1
            },
            {
                "id": 595,
                "api_version": 3,
                "date_start": "1528377227",
                "total_emails": 20,
                "invalid_emails": 0,
                "processed_emails": 20,
                "failed_emails": 0,
                "ready": 1
            },
            {
                "id": 544,
                "api_version": 2,
                "date_start": "1528204702",
                "total_emails": 500,
                "invalid_emails": 0,
                "processed_emails": 500,
                "failed_emails": 0,
                "ready": 1
            }
        ],
        "from": 1,
        "last_page": 1,
        "per_page": 10,
        "to": 3,
        "total": 3
    }
}

Code: 200 OK.

Paramètres d'entrée

response

L’objet response.

Contient le champ 'data' avec un tableau de données sur les requêtes de l’utilisateur en cas de succès.

Les champs « De » et « À » représentent la plage d’ID du jeu de résultats des requêtes renvoyées pour la page actuelle.

'per_page' est la taille des pages et 'total' est le nombre de requêtes dans le jeu de résultats.

Le current_page et le last_page correspondent au nombre de pages du jeu de résultats.

En cas d’erreur, il contient sa description dans le champ 'erreur' . S’il y a plusieurs erreurs, leurs descriptions sont renvoyées dans le tableau 'errors' .

data

Tableau.

Une liste des éléments d’information de vos requêtes (si 'onlyIds' est vrai, chaque élément n’a que le champ 'id' ).

data[k].id

String.

Request ID.

data[k].api_version

Entier.

Version de l’API utilisée pour la requête.

data[k].date_start

String.

Représentation sous forme de chaîne de l’horodatage Unix de début de la demande.

data[k].total_emails

Entier.

Le nombre total d’e-mails dans la demande.

data[k].invalid_emails

Entier.

Nombre d’e-mails non valides.

data[k].processed_emails

Entier.

Nombre d’adresses e-mail déjà traitées.

data[k].failed_emails

Entier.

Nombre d’e-mails qui n’ont pas pu être traités.

data[k].ready

Entier.

1 si le traitement est terminé, 0 – sinon.

from

Entier.

ID de demande min. dans la page actuelle de l’ensemble de données.

to

Entier.

ID de demande max. dans la page actuelle de l’ensemble de données.

per_page

Entier.

Nombre max. de requêtes pour chaque page du jeu de résultats.

total

Entier.

Nombre total de demandes dans le jeu de résultats.

current_page

Entier.

Numéro de la page actuelle dans le jeu de résultats.

last_page

Entier.

Numéro de la dernière page de l’ensemble.

error

String.

Description de l’erreur.

errors

Tableau.

Plusieurs messages d’erreur.