Obter uma lista de suas solicitações | Documentação | Email Verification Bulk API | WhoisXML API

Obter uma lista de suas solicitações

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

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

Exemplo de corpo de solicitação POST

{
    "apiKey": "YOUR_API_KEY",
    "page": 1,
    "format": "json",
    "onlyIds": false,
    "perPage": 10,
    "sort": "desc"
}

Parâmetros de entrada

apiKey

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

page

Optional. Inteiro.

Usado para paginar os conjuntos de resultados em conjunto com 'perPage'.

Default value: 1.

onlyIds

Optional. Boolean.

Quando isso for verdadeiro, somente a lista de IDs será retornada.

Default value: true.

perPage

Optional. Inteiro.

Limita cada página do conjunto de resultados a esse número de solicitações.

Min: 10; Max: 50.

Default value: 10

sort

Opcional. String.

Especifique a ordem das solicitações na resposta.

Allowed values: "asc", "desc".

Default value: "desc".

format

Opcional. String.

Usado para especificar o formato da resposta.

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

Default value: "json".

Saída de amostra

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

response

O objeto de resposta.

Contém o campo "data" com uma matriz de dados das solicitações do usuário em caso de sucesso.

Os campos "from" e "to" representam o intervalo de IDs do conjunto de resultados das solicitações retornadas para a página atual.

'per_page' é o tamanho das páginas e 'total' é o número de solicitações no conjunto de resultados.

A 'current_page' e a 'last_page' correspondem ao número de páginas no conjunto de resultados.

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

data

Array.

Uma lista dos elementos de informação de suas solicitações (se "onlyIds" for true, cada elemento terá apenas o campo "id" ).

data[k].id

String.

ID da solicitação.

data[k].api_version

Inteiro.

Versão da API usada para a solicitação.

data[k].date_start

String.

Representação em cadeia de caracteres do carimbo de data/hora Unix de início da solicitação.

data[k].total_emails

Inteiro.

O total do número de e-mails na solicitação.

data[k].invalid_emails

Inteiro.

Número de e-mails inválidos.

data[k].processed_emails

Inteiro.

Número de endereços de e-mail já processados.

data[k].failed_emails

Inteiro.

Número de e-mails que não puderam ser processados.

data[k].ready

Inteiro.

1 se o processamento tiver sido concluído, 0 - caso contrário.

from

Inteiro.

Min. ID da solicitação na página atual do conjunto de dados.

to

Inteiro.

ID máxima da solicitação na página atual do conjunto de dados.

per_page

Inteiro.

Número máximo de solicitações para cada página do conjunto de resultados.

total

Inteiro.

O número total de solicitações no conjunto de resultados.

current_page

Inteiro.

Número da página atual no conjunto de resultados.

last_page

Inteiro.

O número da última página do conjunto.

error

String.

Descrição do erro.

errors

Array.

Várias mensagens de erro.