リクエスト一覧の取得 | ドキュメント | Email Verification Bulk 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

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

page

任意。整数。

「perPage」と組み合わせて、結果セットをページ分割するために使用します。

初期値:1。

onlyIds

任意。ブール値。

trueの場合は、IDのリストのみが返されます。

初期値:true。

perPage

任意。整数。

結果セットの各ページをこのリクエスト数に制限します。

最小:10、最大:50

初期値:10

sort

任意。文字列。

応答におけるリクエストの順序を指定します。

使用可能な値:"asc"、"desc"。

初期値:"desc"。

format

任意。文字列。

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

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

入力パラメータ

response

応答オブジェクト。

「data」フィールドに、成功した場合のユーザのリクエストデータの配列を格納します。

「from」「to」は、現在のページのリクエストに対して返される結果セットのIDの範囲を表します。

「per_page」はページのサイズ、「total」は結果セットのリクエスト数です。

「current_page」「last_page」は、結果セットのページ数に対応しています。

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

data

配列。

リクエストの info要素のリスト(「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。

from

整数。

データセットの現ページにおける最小リクエストID。

to

整数。

データセットの現ページにおける最大リクエストID。

per_page

整数。

結果セットの各ページにおける最大リクエスト数。

total

整数。

結果セット内のリクエスト総数。

current_page

整数。

結果セットの現在のページ番号。

last_page

整数。

セットの最後のページ番号。

error

文字列。

エラーの説明。

errors

配列。

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