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"}'
{
"apiKey": "YOUR_API_KEY",
"page": 1,
"format": "json",
"onlyIds": false,
"perPage": 10,
"sort": "desc"
}
api密钥 |
必填。在我的产品页面获取个人 API 密钥。 |
页 |
选填。整数。 与'perPage'结合使用,对结果集进行分页。 默认值:1。 |
onlyIds |
选填。布尔值。 当其为真时,仅返回 ID 列表。 默认值: 真。 |
每页 |
选填。整数。 将结果集的每一页限制为此请求的数量。 最小值: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范围。 “每页”是页面大小, “全部”是结果集中的请求数。 “current_page”和“last_page”对应结果集中的页数。 如果发生错误,其描述将包含在“error”字段中。如果有多个错误,则其描述将返回到“errors”数组中。 |
数据 |
数组。 请求的信息元素列表(如果“onlyIds”为真,则每个元素只有“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。 |
到 |
整数。 数据集当前页中的最大请求ID。 |
每页 |
整数。 结果集每页的最大请求数。 |
全部 |
整数。 结果集中的请求总数。 |
当前页 |
整数。 结果集中的当前页码。 |
最后一页 |
整数。 该集中最后一页的页码。 |
错误 |
字符 错误描述。 |
错误 |
数组。 多条错误消息。 |