更新时间:2025-08-30 GMT+08:00
分享

查询收件人状态

功能介绍

查询收件人状态

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/workspaces/{workspace_id}/sa/reports/emails/search

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

workspace_id

String

工作空间ID

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

email_address

String

收件人邮箱,可以为多个,多个时由英文分号(";")分割

响应参数

状态码:200

表3 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID,格式为:request_uuid-timestamp-hostname

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of EmailStatusInfo objects

EmailStatusInfo

表5 EmailStatusInfo

参数

参数类型

描述

report_address

String

邮箱地址

email_status

Boolean

邮箱状态,为true时表示可直接发送;false时需要先发送确认邮件

状态码:400

表6 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID,格式为:request_uuid-timestamp-hostname

表7 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

请求示例

响应示例

状态码

状态码

描述

200

请求成功

400

请求失败

错误码

请参见错误码

相关文档