edit-icon download-icon

ListEmailVerification

Last Updated: Jan 29, 2018

Description

The ListEmailVerification API queries the list of email address verification tasks under the current account and returns the results by page.

Request parameters

For more information about public request parameters, see Public parameters.

Parameter Type Required Description
Action String Yes API of the action, system required parameter. Set this parameter to ListEmailVerification.
PageNum Integer Yes Page number
PageSize Integer Yes Page size
BeginCreateTime Long No Start time of the period in which the email addresses are verified, expressed by the number of milliseconds between the start time and the UTC time 00:00 on January 1, 1970. Currently, only query by day is supported.
EndCreateTime Long No End time of the period in which the email addresses are verified, expressed by the number of milliseconds between the end time and the UTC time 00:00 on January 1, 1970. Currently, only query by day is supported.
Email String No Email address to be verified
VerificationStatus Integer No Verification status. The enumerated values include:
  • 0: waiting for verification.
  • 1: successfully verified.
Lang String No Language of the information returned from the API. The enumerated values include zh (Chinese) and en (English). The default value is en.

Response parameters

Parameter Type Description
RequestId String Unique request identifier
TotalItemNum Integer Total number of domain names
CurrentPageNum Integer Current page number
TotalPageNum Integer Total number of pages
PageSize Integer Page size
PrePage Boolean Whether the previous page exists
NextPage Boolean Whether the next page exists
Data EmailVerificationType List of email address verification tasks

Error codes

Error code Description HTTP status code Semantics
ParameterIllegal Parameter illegal. 400 Parameter error
NetworkIOError Network IO Error. 400 Network I/O exception

Examples

Request example

  1. http://domain-intl.aliyuncs.com/?Action=ListEmailVerification
  2. &PageNum=1
  3. &PageSize=1
  4. &<Public request parameters>

Response example

  • XML format
  1. <?xml version='1.0' encoding='UTF-8'?>
  2. <ListEmailVerificationResponse>
  3. <Data>
  4. <EmailVerification>
  5. <ConfirmIp>127.0.0.1</ConfirmIp>
  6. <TokenSendTime>Dec 25,2017 03:38:46</TokenSendTime>
  7. <Email>test1@aliyun.com</Email>
  8. <VerificationStatus>1</VerificationStatus>
  9. <SendIp>127.0.0.1</SendIp>
  10. <VerificationTime>Dec 25,2017 03:41:11</VerificationTime>
  11. <EmailVerificationNo>00000a21fd374da99d9c95b48500000</EmailVerificationNo>
  12. <UserId>0000</UserId>
  13. <GmtCreate>Dec 25,2017 03:38:46</GmtCreate>
  14. <GmtModified>Dec 25,2017 03:41:11</GmtModified>
  15. </EmailVerification>
  16. <EmailVerification>
  17. <ConfirmIp>127.0.0.1</ConfirmIp>
  18. <TokenSendTime>Dec 25,2017 03:35:22</TokenSendTime>
  19. <Email>test2@aliyun.com</Email>
  20. <VerificationStatus>1</VerificationStatus>
  21. <SendIp>127.0.0.1</SendIp>
  22. <VerificationTime>Dec 25,2017 03:36:57</VerificationTime>
  23. <EmailVerificationNo>0000021fd374da99d9c95b48500000</EmailVerificationNo>
  24. <UserId>0000</UserId>
  25. <GmtCreate>Dec 25,2017 03:32:40</GmtCreate>
  26. <GmtModified>Dec 25,2017 03:36:57</GmtModified>
  27. </EmailVerification>
  28. </Data>
  29. <TotalItemNum>2</TotalItemNum>
  30. <PageSize>500</PageSize>
  31. <CurrentPageNum>1</CurrentPageNum>
  32. <RequestId>4BF41EC0-C147-4F88-8B3D-D569AF5C3E8B</RequestId>
  33. <PrePage>false</PrePage>
  34. <TotalPageNum>1</TotalPageNum>
  35. <NextPage>false</NextPage>
  36. </ListEmailVerificationResponse>
  • JSON format
  1. {
  2. "currentPageNum": 1,
  3. "data": [
  4. {
  5. "confirmIp": "127.0.0.1",
  6. "email": "test1@aliyun.com",
  7. "emailVerificationNo": "00000a21fd374da99d9c95b48500000",
  8. "gmtCreate": "Dec 25,2017 03:38:46",
  9. "gmtModified": "Dec 25,2017 03:41:11",
  10. "sendIp": "127.0.0.1",
  11. "tokenSendTime": "Dec 25,2017 03:38:46",
  12. "userId": "0000",
  13. "verificationStatus": 1,
  14. "verificationTime": "Dec 25,2017 03:41:11"
  15. },
  16. {
  17. "confirmIp": "127.0.0.1",
  18. "email": "test2@aliyun.com",
  19. "emailVerificationNo": "0000021fd374da99d9c95b48500000",
  20. "gmtCreate": "Dec 25,2017 03:32:40",
  21. "gmtModified": "Dec 25,2017 03:36:57",
  22. "sendIp": "127.0.0.1",
  23. "tokenSendTime": "Dec 25,2017 03:35:22",
  24. "userId": "0000",
  25. "verificationStatus": 1,
  26. "verificationTime": "Dec 25,2017 03:36:57"
  27. }
  28. ],
  29. "nextPage": false,
  30. "pageSize": 500,
  31. "prePage": false,
  32. "requestId": "09D3DA75-B3B5-480B-9100-92DC43919B46",
  33. "totalItemNum": 2,
  34. "totalPageNum": 1
  35. }
Thank you! We've received your feedback.