获取您的请求列表 | 文档 | 电子邮件验证批量 API | WhoisXML API

获取您的请求列表

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

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"}'

POST 请求正文示例

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

输入参数

apiKey

必填。在我的产品页面获取个人 API 密钥。

选填。整数。

'perPage'结合使用来对结果集进行分页。

默认值:1。

onlyIds

选填。布尔值。

当结果为true时,仅返回 ID 列表。

默认值: true。

每页

选填。整数。

将结果集的每一页限制为此请求的数量。

最小值:10;最大值:50。

默认值: 10

分类

选填。字符串。

指定搜索响应结果中的请求顺序。

允许的值:“asc”、“desc”。

默认值:“desc”。

格式

选填。字符串。

用于指定响应格式。

允许的值:“xml”、“json”、“csv”。

默认值:“json”。

样本输出

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

输入参数

响应

响应对象。

包含“数据”字段,其中含有用户成功请求的数据数组。

‘from’‘to’字段代表当前页面返回的请求结果集的ID范围。

“per_page”是页面大小, “total”是结果集中的请求数。

“current_page”“last_page”对应结果集中的页数。

如果出现错误,则会在“错误”字段中包含其描述。如果存在多个错误,则它们的描述将在“错误”数组中返回。

数据

数组。

您的请求的信息元素列表(如果“onlyIds”true,则每个元素只有“id”字段)。

data[k].id

字符。

请求 ID。

data[k].api_version

整数。

用于搜索请求的 API 版本。

data[k].date_start

字符。

搜索请求的开头Unix 时间戳的字符串表示形式。

data[k].total_emails

整数。

请求中的电子邮件总数。

data[k].invalid_emails

整数。

无效电子邮件的数量。

data[k].processed_emails

整数。

已处理的电子邮件地址的数量。

data[k].failed_emails

整数。

无法处理的电子邮件的数量。

data[k].ready

整数。

值为1时表示处理已完成,否则值为 0。

整数。

数据集当前页面中的最小请求ID。

to

整数。

数据集当前页中的最大请求ID。

每页

整数。

每页结果集的最大请求数。

全部的

整数。

结果集中的请求总数。

当前页面

整数。

结果集中的当前页码。

最后一页

整数。

该集中最后一页的页码。

错误

字符。

错误描述。

错误

数组。

多条错误消息。