调用SubmitEmailVerification接口发送邮箱验证邮件。

API描述

收到验证邮件后您需要在3天内登录邮箱完成验证。如果验证邮件已过期,您可以调用ResendEmailVerification接口重新发送验证邮件。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String SubmitEmailVerification

系统规定参数,取值:SubmitEmailVerification

Email String username@example.com

需要完成验证的邮箱,多个邮箱之间使用英文逗号(,)隔开。

SendIfExist Boolean false

验证邮件已经存在时是否重新发送邮件。取值:

  • true:重新发送验证邮件。
  • false:不重新发送验证邮件。

默认值为false

Lang String en

接口返回错误信息语言。取值:

  • zh:中文。
  • en:英文。

默认值为en

UserClientIp String 127.0.0.1

用户IP,可设置为127.0.0.1。

返回数据

名称 类型 示例值 描述
ExistList Array of SendResult

验证邮件已经存在列表。

Code String SendTokenQuotaExceeded

返回code。

Email String username@example.com

验证邮箱。

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

返回信息。

FailList Array of SendResult

验证邮件发送失败列表。

Code String SendTokenQuotaExceeded

返回code。

Email String username@example.com

验证邮箱。

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

返回信息。

SuccessList Array of SendResult

验证邮件发送成功列表。

Code String Success

返回code。

Email String username@example.com

验证邮箱。

Message String Success

返回信息。

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

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=SubmitEmailVerification
&Email=username@example.com
&<公共请求参数>

正常返回示例

XML格式

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

JSON格式

{
    "RequestId": "E2A8A5EF-DF8A-4C48-8FD4-9F6BD71AB26D",
    "ExistList": {
        "Email": "username@example.com",
        "Message": "The maximum number of attempts allowed to send the email verification link is exceeded.",
        "Code": "SendTokenQuotaExceeded"
    },
    "SuccessList": {
        "Email": "username@example.com",
        "Message": "Success",
        "Code": "Success"
    },
    "FailList": {
        "Email": "username@example.com",
        "Message": "The maximum number of attempts allowed to send the email verification link is exceeded",
        "Code": "SendTokenQuotaExceeded"
    }
}

错误码

访问错误中心查看更多错误码。