Criar uma nova solicitação | Documentação | Email Verification Bulk API | WhoisXML API

Criar uma nova solicitação

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

Exemplo de solicitação 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"}'

Exemplo de corpo de solicitação POST

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

Parâmetros de entrada

apiKey

Obrigatório. Obtenha sua chave de API pessoal na página Meus produtos.

emails

Necessário. Variedade.

Contém uma matriz de endereços de e-mail para verificação.

version

Opcional. Número.

Define a versão da Email Verification API a ser usada.

Valores permitidos: 2 e 3.

Default value: 2. Please use version 3 of the API after April 30, 2024.

OBSERVAÇÃO: a versão 2 da Email Verification API está sendo descontinuada após o lançamento da versão 3, que oferece melhor estabilidade e resultados mais precisos. Para saber mais sobre a nova versão, visite esta página de especificações. Após 30 de abril de 2024, a API v2 será descontinuada e as consultas não serão mais atendidas.

format

Opcional. String.

Usado para especificar o formato da resposta.

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

Default value: "json".

Saída de amostra

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

O objeto de resposta.

Contém o campo inteiro 'id' em caso de sucesso.

No caso de um erro, ele contém sua descrição no campo "error". Se houver vários erros, suas descrições serão retornadas na matriz "errors".

id

Inteiro.

ID de solicitação de verificação recém-criada.

error

String.

Descrição do erro.

errors

Array.

Várias mensagens de erro.