Queries the verification tasks for a specified email address.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListEmailVerification

The operation that you want to perform. Set the value to ListEmailVerification.

Email String No username@example.com

The email address for which you want to query verification tasks. You can specify only one email address every time.

VerificationStatus Integer No 1

The status of the verification for the email address. Valid values:

  • 0: pending
  • 1: successful
BeginCreateTime Long No 1522080000000

The beginning of the time range when the verification tasks of the email addresses were created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

EndCreateTime Long No 1522080000000

The end of the time range when the verification tasks of the email addresses were created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

PageSize Integer No 500

The number of entries to return on each page. The default value is 0 and the maximum value is 5000. You can set this parameter based on your business requirements.

PageNum Integer No 1

The number of the page to return. The default value is 0. You can set this parameter based on your business requirements.

Lang String No en

The language of the error message to return if the request fails. Valid values:

  • zh: Chinese
  • en: English

Default value: en

UserClientIp String No 127.0.0.1

The IP address of the client. For example, you can set the value to 127.0.0.1.

Response parameters

Parameter Type Example Description
CurrentPageNum Integer 1

The page number of the returned page.

Data Array of EmailVerification

The list of verification tasks for the specified email address.

ConfirmIp String 127.0.0.1

The IP address of the client on which the email address is verified.

Email String username@example.com

The email address submitted for verification.

EmailVerificationNo String 00000a21fd374da99d9c95b48500000

The ID of the email address verification task. By default, the ID is the serial number automatically generated by the system.

GmtCreate String Dec 25,2017 03:38:46

The time when the database record was created.

GmtModified String Dec 25,2017 03:41:11

The time when the database record was updated.

SendIp String 127.0.0.1

The IP address of the client on which the email address was submitted for verification.

TokenSendTime String Dec 25,2017 03:38:46

The time when the token was sent to the email address for verification.

UserId String 0000

The ID of the user.

VerificationStatus Integer 1

The status of the verification for the email address. Valid values:

  • 0: pending
  • 1: successful
VerificationTime String Dec 25,2017 03:41:11

The time when the email address was verified.

NextPage Boolean false

Indicates whether the current page is followed by a page.

PageSize Integer 500

The number of entries returned per page.

PrePage Boolean false

Indicates whether the current page is preceded by a page.

TotalPageNum Integer 1

The total number of pages returned.

TotalItemNum Integer 2

The total number of entries returned.

RequestId String 78C60CC3-FF0A-44E2-989A-DDE0597791C3

The ID of the request.

Examples

Sample requests

 
&<Common request parameters>

Sample success responses

XML format

<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 format

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

Error codes

For a list of error codes, see Service error codes.