Crear una nueva solicitud | Documentación | Email Verification Bulk API | WhoisXML API

Crear una nueva solicitud

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

Ejemplo 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": ["alex@hotmail.edu", "bob@google.com", "mila@yahoo.com"], "format": "json"}'

Ejemplo de cuerpo de solicitud POST

{
    "apiKey": "YOUR_API_KEY",
    "version": 3,
    "emails": [
        "alex@hotmail.edu",
        "bob@google.com",
        "mila@yahoo.com"
    ],
    "format": "json"
}

Parámetros de entrada

apiKey

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

emails

Obligatorio. Matriz.

Contiene una matriz de direcciones de correo electrónico que requiere verificación.

version

Opcional. Número.

Define la versión de Email Verification API que se ha de 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 lEmail Verification API 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 v2 de la API dejará de utilizarse y dejarán de proporcionarse consultas.

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

El objeto de respuesta.

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

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

id

Entero.

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

error

Cuerda.

Descripción del error.

errors

Arreglo.

Múltiples mensajes de error.