Obtenga una lista de sus solicitudes | Documentación | API masiva de verificación de correo electrónico | API WhoisXML

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

Es necesario. 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 por defecto: 1.

onlyIds

Opcional. Booleano.

Cuando es verdadero sólo se devuelve la lista de IDs.

Valor por defecto: verdadero.

perPage

Opcional. Entero.

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

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

Valor por defecto: 10

ordenar

Opcional. Cadena.

Especifique el orden de las solicitudes en la respuesta.

Valores permitidos: "asc", "desc".

Valor por defecto: "desc".

formato

Opcional. Cadena.

Se utiliza para especificar el formato de la 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

respuesta

El objeto de respuesta.

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

Los campos "de" y "a " 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 "página_actual" y "última_página " 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 el array 'errores'.

data

Array.

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

datos[k].id

Cuerda.

ID de solicitud.

data[k].api_version

Entero.

Versión de la API utilizada para la solicitud.

datos[k].fecha_inicio

Cuerda.

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

datos[k].total_correos

Entero.

El total de correos electrónicos de la solicitud.

datos[k].correos_no_válidos

Entero.

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

datos[k].correos_procesados

Entero.

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

datos[k].correos_fallidos

Entero.

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

data[k].ready

Entero.

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

de

Entero.

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

a

Entero.

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

por_página

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.

página_actual

Entero.

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

última_página

Entero.

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

error

Cuerda.

Descripción del error.

errores

Array.

Múltiples mensajes de error.