Criar uma nova solicitação | Documentação | API de verificação de e-mail em massa | API WhoisXML

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": ["[email protected]", "[email protected]", "[email protected]"], "format": "json"}'

Exemplo de corpo de solicitação POST

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

Parâmetros de entrada

apiKey

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

e-mails

Necessário. Matriz.

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

versão

Opcional. Número.

Define a versão da API de verificação de e-mail a ser usada.

Valores permitidos: 2 e 3.

Valor padrão: 2. Use a versão 3 da API após 30 de abril de 2024.

OBSERVAÇÃO: a versão 2 da API de verificação de e-mail 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.

formato

Opcional. String.

Usado para especificar o formato da resposta.

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

Valor padrão: "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.
resposta

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.

erro

Cordas.

Descrição do erro.

erros

Matriz.

Várias mensagens de erro.