Obtenir une liste de vos demandes | Documentation | Email Verification Bulk API | 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

clé api

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

page

Optionnel. Entier.

Utilisé pour paginer les ensembles de résultats en conjonction avec "perPage".

Valeur par défaut : 1.

onlyIds

Facultatif. Booléen.

Si c'est vrai, seule la liste des identifiants est renvoyée.

Valeur par défaut : true.

parPage

Optionnel. Entier.

Limite chaque page de l'ensemble de résultats à ce nombre de requêtes.

Min : 10 ; Max : 50.

Valeur par défaut : 10

trier

Facultatif. Chaîne.

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

Valeurs autorisées : "asc", "desc".

Valeur par défaut : "desc".

format

Facultatif. Chaîne.

Permet de spécifier le format de la 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

réponse

L'objet de la réponse.

Contient le champ "data" avec un tableau des données des demandes de l'utilisateur en cas de succès.

Les champs "from" et "to" représentent la plage d'ID de l'ensemble de résultats des demandes renvoyées pour la page en cours.

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

Les champs "current_page" et "last_page" correspondent au nombre de pages de l'ensemble de résultats.

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

data

Array.

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

data[k].id

Chaîne de caractères.

ID de la demande.

data[k].api_version

Entier.

Version de l'API utilisée pour la demande.

data[k].date_start

Chaîne de caractères.

Représentation sous forme de chaîne de caractères de l'horodatage Unix du début de la demande.

data[k].total_emails

Entier.

Le nombre total de courriels dans la demande.

data[k].invalid_emails

Entier.

Nombre de courriels non valides.

data[k].processed_emails

Entier.

Nombre d'adresses électroniques déjà traitées.

data[k].failed_emails

Entier.

Nombre de courriels qui n'ont pas pu être traités.

data[k].ready

Entier.

1 si le traitement est terminé, 0 sinon.

de

Entier.

ID de la demande minimale dans la page actuelle de l'ensemble de données.

à

Entier.

ID de demande maximale dans la page actuelle de l'ensemble de données.

par page

Entier.

Nombre maximal de demandes pour chaque page de l'ensemble des résultats.

total

Entier.

Le nombre total de demandes dans l'ensemble de résultats.

page_actuelle

Entier.

Numéro de la page actuelle dans l'ensemble des résultats.

dernière_page

Entier.

Le numéro de la dernière page du jeu.

erreur

Chaîne de caractères.

Description de l'erreur.

erreurs

Array.

Plusieurs messages d'erreur.