新しいリクエストを作成 | ドキュメント | 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": ["[email protected]", "[email protected]", "[email protected]"], "format": "json"}'

POSTリクエストボディのサンプル

{
    "apiKey": "YOUR_API_KEY",
    "version": 3,
    "emails": [
        "[email protected]",
        "[email protected]",
        "[email protected]"
    ],
    "format": "json"
}

入力パラメータ

apiKey

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

emails

必須。配列。

認証するメールアドレスの配列が含まれます。

version

任意。番号。

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

使用可能な値:2および3

初期値:2。2024年4月30日以降は、バージョン3のAPIをご利用ください。

注意: Email Verification API バージョン 2 は、より安定性が高く、より正確な結果を提供するバージョン 3 のリリースに伴い、廃止される予定です。 新しいバージョンについての詳細は、こちらの仕様ページをご覧ください。 2024年4月30日以降、v2 API は廃止され、クエリは提供されなくなります。

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

Responseオブジェクト。

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

エラーが発生した場合は、その説明が「error」フィールドに含まれます。複数のエラーが発生した場合は、それらの説明が「errors」配列で返されます。

id

整数。

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

error

文字列。

エラーの説明。

errors

配列。

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