All Products
Search
Document Center

Domain Names:QueryEmailVerification

Last Updated:Jun 20, 2024

Queries whether an email address is verified.

Debugging

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

Request parameters

Parameter

Type

Required

Example

Description

Action

String

Yes

QueryEmailVerification

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

Email

String

Yes

abc@aliyun.com

The email address that you want to query.

Lang

String

No

en

The language of the error message returned. Valid values:

  • zh: Chinese

  • en: English

Default value: en.

UserClientIp

String

No

127.0.0.1

The IP address of the client that is used for the query. Set the value to 127.0.0.1.

Response parameters

Parameter

Type

Example

Description

ConfirmIp

String

42.*. *.31

The IP address of the client whose email address is verified.

Email

String

abc@aliyun.com

The email address that is queried.

EmailVerificationNo

String

72b36ba0572e423bbb3f19640896****

The ID of the email address that is verified. The ID is automatically generated by the system.

GmtCreate

String

2019-02-19 16:38:07

The creation time of the email address recorded in the database.

GmtModified

String

2019-02-19 16:40:38

The update time of the email address recorded in the database.

RequestId

String

FC4F7D02-8A83-4E37-B935-2D48A1B8423E

The ID of the request.

SendIp

String

42.*. *.115

The IP address of the client from which the email address verification was initiated.

TokenSendTime

String

2019-02-19 16:38:07

The time when the email verification token was sent.

UserId

String

140692647406****

The ID of the user account.

VerificationStatus

Integer

1

The verification status of the email address. Valid values:

  • 0: The email address is waiting to be verified.

  • 1: The email address is verified.

VerificationTime

String

2019-02-19 16:40:38

The time when the email address verification was completed.

Examples

Sample requests

http(s)://domain.aliyuncs.com/? Action=QueryEmailVerification
&<Common request parameters>

Sample success responses

XML format

<QueryEmailVerificationResponse>
  <ConfirmIp>42. *. *.31</ConfirmIp>
  <TokenSendTime>2019-02-19 16:38:07</TokenSendTime>
  <Email>abc@aliyun.com</Email>
  <RequestId>FC4F7D02-8A83-4E37-B935-2D48A1B8423E</RequestId>
  <VerificationStatus>1</VerificationStatus>
  <SendIp>42. *. *.115</SendIp>
  <VerificationTime>2019-02-19 16:40:38</VerificationTime>
  <EmailVerificationNo>72b36ba0572e423bbb3f19640896****</EmailVerificationNo>
  <UserId>140692647406****</UserId>
  <GmtCreate>2019-02-19 16:38:07</GmtCreate>
  <GmtModified>2019-02-19 16:40:38</GmtModified>
</QueryEmailVerificationResponse>

JSON format

{
    "ConfirmIp": "42. *. *.31",
    "TokenSendTime": "2019-02-19 16:38:07",
    "Email": "abc@aliyun.com",
    "RequestId": "FC4F7D02-8A83-4E37-B935-2D48A1B8423E",
    "VerificationStatus": 1,
    "SendIp": "42. *. *.115",
    "VerificationTime": "2019-02-19 16:40:38",
    "EmailVerificationNo": "72b36ba0572e423bbb3f19640896****",
    "UserId": "140692647406****",
    "GmtCreate": "2019-02-19 16:38:07",
    "GmtModified": "2019-02-19 16:40:38"
}

Error codes

For a list of error codes, visit the API Error Center.