edit-icon download-icon

SubmitEmailVerification

Last Updated: Jan 29, 2018

Description

According to the ICANN policies and regulations, the email address of a domain name owner must be verified. The SubmitEmailVerification API submits email address verification task.

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 SubmitEmailVerification.
Email String Yes Email address. Use commas (,) to separate multiple email addresses.
SendIfExist Boolean Yes Whether to repeatly send the verification email if the verification record already exists
Lang String No Language of the error message 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
SuccessList SendResultType The success list is sent.
FailList SendResultType The failure list is sent.
ExistList SendResultType A list already exists.

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=SubmitEmailVerification
  2. &InstanceId=ST2017120814571100001303
  3. &<Public request parameters>

Response example

  • XML format
  1. <?xml version='1.0' encoding='UTF-8'?>
  2. <SubmitEmailVerificationResponse>
  3. <FailList>
  4. <SendResult>
  5. <Email>aaa@test.com</Email>
  6. <Message>The maximum number of attempts allowed to send the email
  7. verification link is exceeded.
  8. </Message>
  9. <Code>SendTokenQuotaExceeded</Code>
  10. </SendResult>
  11. </FailList>
  12. <RequestId>E2A8A5EF-DF8A-4C48-8FD4-9F6BD71AB26D</RequestId>
  13. <ExistList />
  14. <SuccessList>
  15. <SendResult>
  16. <Email>ccc@test.com</Email>
  17. <Message />
  18. <Code />
  19. </SendResult>
  20. <SendResult>
  21. <Email>ddd@test.com</Email>
  22. <Message />
  23. <Code />
  24. </SendResult>
  25. </SuccessList>
  26. </SubmitEmailVerificationResponse>
  • JSON format
  1. {
  2. "existList": [
  3. {
  4. "email": "aaa@test.com"
  5. }
  6. ],
  7. "failList": [
  8. {
  9. "code": "SendTokenQuotaExceeded",
  10. "email": "bbb@test.com",
  11. "message": "The maximum number of attempts allowed to send the email verification link is exceeded."
  12. }
  13. ],
  14. "requestId": "2EF65AFD-A2C4-48D3-B326-ACB52B5A6771",
  15. "successList": [
  16. {
  17. "email": "ccc@test.com"
  18. },
  19. {
  20. "email": "ddd@test.com"
  21. }
  22. ]
  23. }
Thank you! We've received your feedback.