指定した電子メールアドレスの検証タスクを照会します。
デバッグ
リクエストパラメーター
| パラメーター | 型 | 必須 / 任意 | 例 | 説明 |
| Action | String | はい | ListEmailVerification | 実行する操作です。 値をListEmailVerificationに設定します。 |
| 電子メール | String | 任意 | username@example.com | 確認タスクを照会するメールアドレス。 毎回指定できるメールアドレスは1つだけです。 |
| VerificationStatus | Integer | いいえ | 1 | メールアドレスの確認のステータス。 有効な値:
|
| BeginCreateTime | Long | いいえ | 1522080000000 | メールアドレスの検証タスクが作成された時間範囲の開始。 この値は、1970 年 1 月 1 日 00:00:00 UTC (エポックタイム) から経過した時間をミリ秒で示す UNIX タイムスタンプです。 |
| EndCreateTime | Long | いいえ | 1522080000000 | メールアドレスの検証タスクが作成された時間範囲の終了。 この値は、1970 年 1 月 1 日 00:00:00 UTC (エポックタイム) から経過した時間をミリ秒で示す UNIX タイムスタンプです。 |
| PageSize | Integer | いいえ | 500 | 各ページで返されるエントリ数です。 デフォルト値は0、最大値は5000です。 このパラメーターは、ビジネス要件に基づいて設定できます。 |
| PageNum | Integer | いいえ | 1 | 返されるページ数です。 デフォルト値は0です。 このパラメーターは、ビジネス要件に基づいて設定できます。 |
| Lang | String | 任意 | en | リクエストが失敗した場合に返されるエラーメッセージの言語。 有効な値:
デフォルト値: en |
| UserClientIp | String | 任意 | 127.0.0.1 | クライアントの IP アドレスです。 たとえば、値を127.0.0.1に設定できます。 |
レスポンスパラメーター
| パラメーター | タイプ | 例 | 説明 |
| CurrentPageNum | Integer | 1 | 返されたページの数です。 |
| Data | EmailVerificationの配列 | 指定されたメールアドレスの確認タスクのリスト。 |
|
| ConfirmIp | String | 127.0.0.1 | メールアドレスが検証されたクライアントのIPアドレス。 |
| 電子メール | String | username@example.com | 確認のために送信されたメールアドレス。 |
| EmailVerificationNo | String | 00000a21fd374da99d9c95b48500000 | メールアドレス確認タスクのID。 デフォルトでは、IDはシステムによって自動的に生成されるシリアル番号です。 |
| GmtCreate | String | 12月25,2017日03:38:46 | データベースレコードが作成された時刻。 |
| GmtModified | String | 12月25,2017 03:41:11 | データベースレコードが更新された時刻。 |
| SendIp | String | 127.0.0.1 | 電子メールアドレスが検証のために送信されたクライアントのIPアドレス。 |
| TokenSendTime | String | 12月25,2017日03:38:46 | 確認のためにトークンが電子メールアドレスに送信された時刻。 |
| UserId | String | 0000 | ユーザーの ID。 |
| VerificationStatus | Integer | 1 | メールアドレスの確認のステータス。 有効な値:
|
| VerificationTime | String | 12月25,2017 03:41:11 | メールアドレスが確認された時刻。 |
| NextPage | Boolean | false | 現在のページの後にページが続くかどうかを示します。 |
| PageSize | Integer | 500 | 1 ページあたりで返されるエントリ数です。 |
| PrePage | Boolean | false | 現在のページの前にページがあるかどうかを示します。 |
| TotalPageNum | Integer | 1 | 返されたページの総数。 |
| TotalItemNum | Integer | 2 | 返されたエントリの総数です。 |
| RequestId | String | 78C60CC3-FF0A-44E2-989A-DDE0597791C3 | リクエストの ID。 |
例
リクエストの例
&<Common request parameters>
成功レスポンスの例
XML 形式
<ListEmailVerificationResponse>
<Data>
<EmailVerification>
<ConfirmIp>127.0.0.1</ConfirmIp>
<TokenSendTime>Dec 25,2017 03:38:46</TokenSendTime>
<Email>username@example.com</Email>
<VerificationStatus>1</VerificationStatus>
<SendIp>127.0.0.1</SendIp>
<VerificationTime>Dec 25,2017 03:41:11</VerificationTime>
<EmailVerificationNo>00000a21fd374da99d9c95b48500000</EmailVerificationNo>
<UserId>0000</UserId>
<GmtCreate>Dec 25,2017 03:38:46</GmtCreate>
<GmtModified>Dec 25,2017 03:41:11</GmtModified>
</EmailVerification>
</Data>
<TotalItemNum>2</TotalItemNum>
<PageSize>500</PageSize>
<CurrentPageNum>1</CurrentPageNum>
<RequestId>4BF41EC0-C147-4F88-8B3D-D569AF5C3E8B</RequestId>
<PrePage>false</PrePage>
<TotalPageNum>1</TotalPageNum>
<NextPage>false</NextPage>
</ListEmailVerificationResponse>
JSON 形式
{
"PrePage": false,
"CurrentPageNum": 1,
"PageSize": 500,
"RequestId": "78C60CC3-FF0A-44E2-989A-DDE0597791C3",
"TotalPageNum": 1,
"Data": [
{
"VerificationStatus": 0,
"GmtCreate": "2020-08-07 15:34:18",
"Email": "username@example.com",
"EmailVerificationNo": "c8b3ede2e65742478eb8216ebf94b62a",
"UserId": "1406926474064770",
"GmtModified": "2020-08-07 15:54:09",
"SendIp": "127.0.0.1",
"TokenSendTime": "2020-08-07 15:54:09"
}
],
"TotalItemNum": 1,
"NextPage": false
}
エラーコード
エラーコードの一覧については、「サービスエラーコード」をご参照ください。