创建新请求 | 文档 | 电子邮件验证批量 API | WhoisXML API

创建一个新请求

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

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

POST 请求正文示例

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

输入参数

apiKey

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

电子邮件

必須。阵列。

包含用于验证的电子邮件地址数组。

版本

可选。数字。

定义要使用的电子邮件验证 API 的版本。

允许的值: 23

默认值: 2 。2024 年 4 月 30 日后请使用 API 版本3

注意:电子邮件验证 API 版本 2 将在版本 3 发布后弃用,版本 3 提供了更好的稳定性和更准确的结果。要了解有关新版本的更多信息,请访问此规范页面。2024 年 4 月 30 日之后,v2 API 将停用,查询将不再提供。

格式

选填。字符串。

用于指定响应格式。

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

默认值:“json”。

样本输出

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

响应对象。

成功时包含整数“id”字段。

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

ID

整数。

新创建的验证请求ID。

错误

细绳。

错误描述。

错误

大批。

多条错误消息。