Obtenga una lista de sus solicitudes | Documentación | Email Verification Bulk API | WhoisXML API

Obtenga una lista de sus peticiones

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

Muestra 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.

page

Opcional. Íntegro.

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

Valor por defecto: 1.

onlyIds

Opcional. Booleano.

Cuando es verdadero solo se devuelve la lista de los ID.

Valor por defecto: true.

perPage

Opcional. Íntegro.

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

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

Valor por defecto: 10

sort

Opcional. Cadena.

Especifique el orden de las solicitudes en la respuesta.

Valores permitidos: "asc", "desc".

Valor por defecto: "desc".

format

Opcional. Cadena.

Se utiliza para especificar el formato de respuesta.

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

Valor por defecto: "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 'from' y 'to' representan el rango de ID del conjunto de resultados de las peticiones devueltas para la página actual.

'per_page' es el tamaño de las páginas y 'total' es el número de peticiones 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, contiene su descripción en el campo 'error'. Si hay varios errores se devuelven sus descripciones en la matriz 'errors'.

data

Matriz.

Una lista de los elementos de información de sus solicitudes (si 'onlyIds' es 'true', cada elemento solo tiene el campo 'id').

data[k].id

Cadena.

ID de solicitud.

data[k].api_version

Íntegro.

Versión de la API utilizada para la solicitud.

data[k].date_start

Cadena.

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

data[k].total_emails

Íntegro.

El total de correos electrónicos de la solicitud.

data[k].invalid_emails

Íntegro.

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

data[k].processed_emails

Íntegro.

Número de direcciones de correo ya procesadas.

data[k].failed_emails

Íntegro.

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

data[k].ready

Íntegro.

1 si el tratamiento ha finalizado, 0 en caso contrario.

from

Íntegro.

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

to

Íntegro.

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

per_page

Íntegro.

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

total

Íntegro.

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

current_page

Íntegro.

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

last_page

Íntegro.

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

error

Cadena.

Descripción del error.

errors

Matriz.

Múltiples mensajes de error.