新しいリクエストの作成 | ドキュメント | Email Verification Bulk 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

必須My productsページでAPI KEYを取得してください。

emails

必須。配列。

認証するメールアドレス。

version

任意。数字。

使用するEmail Verification APIのバージョンを定義します。

使用可能な値:23

初期値:2024年4月30日までは2、以降は3

注意: Email Verification APIバージョン2は、バージョン3のリリースに伴い非推奨となります。バージョン3では、より安定的により正確な結果を提供します。新バージョンの詳細については、こちらの仕様ページをご参照ください。v2のAPIは2024年4月30日をもって終了し、クエリは処理されなくなります。

format

任意。文字列。

応答形式の指定に使用されます。

使用可能な値:"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.
response

応答オブジェクト。

成功時に整数の「id」フィールドを含む。

エラーが発生した場合は、「error」フィールドにその説明が記載されます。複数のエラーが存在する場合は、その説明が「errors」に返されます。

id

整数。

新規作成された認証リクエストID。

error

文字列。

エラーの説明。

errors

配列。

複数のエラーメッセージ。