Crear una nueva solicitud | Documentación | API masiva de verificación de correo electrónico | API WhoisXML

Crear una nueva solicitud

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

Muestra de solicitud CURL

curl https://emailverification.whoisxmlapi.com/api/bevService/request -X POST -H "Content-Type: application/json"  -d '{"apiKey": "YOUR_API_KEY", "version": 3, "emails": ["[email protected]", "[email protected]", "[email protected]"], "format": "json"}'

Ejemplo de cuerpo de solicitud POST

{
    "apiKey": "YOUR_API_KEY",
    "version": 3,
    "emails": [
        "[email protected]",
        "[email protected]",
        "[email protected]"
    ],
    "format": "json"
}

Parámetros de entrada

apiKey

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

correos electrónicos

Necesario. Matriz.

Contiene una matriz de direcciones de correo electrónico para su verificación.

versión

Opcional. Número.

Define la versión de la API de verificación de correo electrónico que se utilizará.

Valores permitidos: 2 y 3.

Valor por defecto: 2. Utilice la versión 3 de la API después del 30 de abril de 2024.

NOTA: La versión 2 de la API de verificación de correo electrónico queda obsoleta tras el lanzamiento de la versión 3, que proporciona mayor estabilidad y resultados más precisos. Para obtener más información sobre la nueva versión, visite esta página de especificaciones. Después del 30 de abril de 2024, la API v2 dejará de utilizarse y dejarán de servirse consultas.

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": {
        "id": 5
    }
}

Code: 200 OK.
{
    "response": {
        "errors": [
            "The format field should have one of the following values: json, xml."
        ]
    }
}

Code: 400 Bad Request.
{
    "response": {
        "error": "Authorisation or authentication failed"
    }
}

Code: 401 Unauthorized.
{
    "response": {
        "error": "Insufficient balance"
    }
}

Code: 402 Payment Required.
respuesta

El objeto de respuesta.

Contiene el campo entero 'id' en caso de éxito.

En caso de error, contiene su descripción en el campo 'error'. Si hay varios errores se devuelven sus descripciones en el array 'errores'.

id

Entero.

ID de solicitud de verificación recién creada.

error

Cuerda.

Descripción del error.

errores

Array.

Múltiples mensajes de error.