获取邮件卡片的邮件列表

获取邮件卡片下的邮件列表

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/mail/v1/user_mailboxes/:user_mailbox_id/messages/get_by_card
HTTP Method	GET
接口频率限制	10 次/秒
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	mail:user_mailbox.message:readonly 查询用户邮件
字段权限要求	> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token

路径参数

名称	类型	描述
user_mailbox_id	string	用户邮箱地址 或 输入me代表当前调用接口用户 示例值："user@xxx.xx 或 me"

查询参数

名称	类型	必填	描述
card_id	string	是	邮件卡片ID，可通过接收消息事件的推送获取 示例值：512ca581-6059-4449-8150-5522e6641d32
owner_id	string	是	邮件卡片Owner ID，可通过接收消息事件的推送获取（与user_id_type无关） 示例值：1234567890
user_id_type	string	否	用户 ID 类型 示例值：open_id 可选值有： - open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多：如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多：如何获取 Union ID？ - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多：如何获取 User ID？ 默认值：open_id 当值为 user_id，字段权限要求： contact:user.employee_id:readonly 获取用户 user ID

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ owner_info	user_info	邮件 Owner 信息
└ type	string	owner是个人邮箱还是公共邮箱 示例值： - user：个人邮箱 - public_mailbox：公共邮箱
└ owner_user_id	string	邮件卡片owner的ID，type为user时非空（与user_id_type对应）
└ public_mailbox_id	string	公共邮箱唯一标识，type为public_mailbox时非空
└ message_ids	string\[\]	邮件ID列表
└ card_id	string	邮件卡片ID

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "owner_info": {
            "type": "user",
            "owner_user_id": "ou_7dab8a3d3cdcc9da365777c7ad115d62",
            "public_mailbox_id": "xxx"
        },
        "message_ids": [
            "TnAwLzVZbjB3TTcyeU5Tek1UMHRFa0l3aStNPQ=="
        ],
        "card_id": "512ca581-6059-4449-8150-5522e6646d32"
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	1230001	参数错误	修改参数后重试
500	1230003	内部错误	请稍后重试
403	1230002	无权限	申请使用邮箱的权限后重试