You can call this operation to submit an email verification task.

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 SubmitEmailVerification

[DO NOT TRANSLATE] Set the value toSubmitEmailVerification.

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

Email String Yes aaa@test.com

The email address to be verified. If multiple email addresses are available, separate them with commas (,).

Lang String No en

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

  • zh: Chinese
  • en: English

Default value:en

SendIfExist Boolean No false

Specifies whether to send the request when a record of the same request already exists.

UserClientIp String No 127.0.0.1

The IP address of the client used by the user to submit the task.

Response parameters

Parameter Type Example Description
ExistList

The list of email addresses that have passed email verification.

Code String SendTokenQuotaExceeded

The code returned after the verification.

Email String aaa@test.com

The email address that was verified.

Message String The maximum number of attempts allowed to send the email verification link is exceeded.

The message returned after the verification.

FailList

The list of email addresses that failed to pass email verification.

Code String SendTokenQuotaExceeded

The code returned after the verification.

Email String bbb@test.com

The email address that was verified.

Message String The maximum number of attempts allowed to send the email verification link is exceeded

The message returned after the verification.

RequestId String E2A8A5EF-DF8A-4C48-8FD4-9F6BD71AB26D

The ID of the request.

SuccessList

The list of email addresses that passed email verification.

Code String Success

The code returned after the verification.

Email String ccc@test.com

The email address that was verified.

Message String Success

The message returned after the verification.

Examples

Sample requests


http(s)://[Endpoint]/? Action=SubmitEmailVerification
&Email=aaa@test.com
&<Common request parameters>

Sample success responses

XML format

<SubmitEmailVerificationResponse>
      <FailList>
            <SendResult>
                  <Email>aaa@test.com</Email>
                  <Message>The maximum number of attempts allowed to send the email
                verification link is exceeded.
            </Message>
                  <Code>SendTokenQuotaExceeded</Code>
            </SendResult>
      </FailList>
      <RequestId>E2A8A5EF-DF8A-4C48-8FD4-9F6BD71AB26D</RequestId>
      <ExistList></ExistList>
      <SuccessList>
            <SendResult>
                  <Email>ccc@test.com</Email>
                  <Message></Message>
                  <Code></Code>
            </SendResult>
            <SendResult>
                  <Email>ddd@test.com</Email>
                  <Message></Message>
                  <Code></Code>
            </SendResult>
      </SuccessList>
</SubmitEmailVerificationResponse>

JSON format

{
	"successList":[
		{
			"email":"ccc@test.com"
		},
		{
			"email":"ddd@test.com"
		}
	],
	"failList":[
		{
			"message":"The maximum number of attempts allowed to send the email verification link is exceeded.",
			"email":"bbb@test.com",
			"code":"SendTokenQuotaExceeded"
		}
	],
	"requestId":"2EF65AFD-A2C4-48D3-B326-ACB52B5A6771",
	"existList":[
		{
			"email":"aaa@test.com"
		}
	]
}

Error codes

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