文档

SubmitEmailVerification - 发送邮箱验证邮件

更新时间:

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

接口说明

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
domain:EmailVerificationOperationWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
Langstring

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

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

默认值为 en

en
Emailstring

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

username@example.com
SendIfExistboolean

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

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

默认值为 false

false
UserClientIpstring

用户 IP,可设置为 127.0.0.1。

127.0.0.1

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

E2A8A5EF-DF8A-4C48-8FD4-9F6BD71AB26D
ExistListobject []

验证邮件已经存在列表。

Emailstring

验证邮箱。

username@example.com
Codestring

返回 code。

SendTokenQuotaExceeded
Messagestring

返回信息。

The maximum number of attempts allowed to send the email verification link is exceeded.
SuccessListobject []

验证邮件发送成功列表。

Emailstring

验证邮箱。

username@example.com
Codestring

返回 code。

Success
Messagestring

返回信息。

Success
FailListobject []

验证邮件发送失败列表。

Emailstring

验证邮箱。

username@example.com
Codestring

返回 code。

SendTokenQuotaExceeded
Messagestring

返回信息。

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

示例

正常返回示例

JSON格式

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

错误码

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

  • 本页导读 (1)
文档反馈