Obtén una lista de tus solicitudes | Documentación | API masiva de verificación de correo electrónico | WhoisXML API

Obtén una lista de tus solicitudes

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

Ejemplo de solicitud 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"}'

Ejemplo de cuerpo de solicitud POST

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

Parámetros de entrada

apiKey

Obligatorio. Obtenga su clave API personal en la página Mis productos .

página

Opcional. Entero.

Se utiliza para paginar los conjuntos de resultados junto con 'perPage'.

Valor predeterminado: 1.

onlyIds

Opcional. Booleano.

Cuando es true, solo se devuelve la lista de identificadores.

Valor predeterminado: true.

por página

Opcional. Entero.

Limita cada página del conjunto de resultados a este número de solicitudes.

Mín.: 10; Máx.: 50.

Valor predeterminado: 10

ordenar

Opcional. Cadena de caracteres.

Especifique el orden de las solicitudes en la respuesta.

Valores permitidos: "asc", "desc".

Valor por defecto: "desc".

format

Opcional. Cadena de caracteres.

Se utiliza para especificar el formato de respuesta.

Valores permitidos: "xml", "json", "csv".

Valor predeterminado: "json".

Muestra de salida

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

Parámetros de entrada

response

El objeto de respuesta.

Contiene el campo 'data' con una matriz de datos de las solicitudes del usuario en caso de éxito.

Los campos "desde" y "hasta" representan el intervalo de ID del conjunto de resultados de las solicitudes devueltas para la página actual.

"per_page" es el tamaño de las páginas y "total" es el número de solicitudes en el conjunto de resultados.

Los valores "current_page" y "last_page" corresponden al número de páginas del conjunto de resultados.

En caso de error, aparce la descripción en el campo 'error' . Si hay varios errores, las descripciones se devuelven en la matriz 'errors' .

datos

Arreglo.

Una lista de los elementos info de tus solicitudes (si 'onlyIds' es true, cada elemento tiene solo el campo 'id' ).

datos[k].id

Cuerda.

ID de solicitud.

datos[k].api_version

Entero.

Versión de API utilizada para la solicitud.

datos[k].date_start

Cuerda.

Representación de cadena de la marca de tiempo Unix de inicio de la solicitud.

datos[k].total_emails

Entero.

El número total de correos electrónicos en la solicitud.

data[k].invalid_emails

Entero.

Número de correos electrónicos no válidos.

data[k].processed_emails

Entero.

Número de direcciones de correo electrónico ya procesadas.

data[k].failed_emails

Entero.

Número de correos electrónicos que no se han podido procesar.

data[k].ready

Entero.

1 si el procesamiento ha finalizado, 0 – en caso contrario.

from

Entero.

ID de solicitud mín. en la página actual del conjunto de datos.

para

Entero.

ID de solicitud máx. en la página actual del conjunto de datos.

per_page

Entero.

Número máximo de solicitudes para cada página del conjunto de resultados.

total

Entero.

El número total de solicitudes en el conjunto de resultados.

current_page

Entero.

Número de página actual en el conjunto de resultados.

last_page

Entero.

El número de la última página del conjunto.

error

Cuerda.

Descripción del error.

errors

Arreglo.

Múltiples mensajes de error.