订阅事件

订阅事件

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/mail/v1/user_mailboxes/:user_mailbox_id/event/subscribe
HTTP Method	POST
接口频率限制	1 次/秒
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	mail:event 订阅邮箱相关事件

请求头

名称	类型	必填	描述
Authorization	string	是	user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token
Content-Type	string	是	固定值："application/json; charset=utf-8"

路径参数

名称	类型	描述
user_mailbox_id	string	用户邮箱地址，使用 user_access_token 时可使用 me 示例值："user@xxx.xx 或 me"

请求体

名称	类型	必填	描述
event_type	int	是	事件类型 示例值：1 可选值有： - 1: 邮件相关事件 数据校验规则： - 取值范围：1 ～ 1

请求体示例

{
    "event_type": 1
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {}
}

错误码

HTTP状态码	错误码	描述	排查建议
400	1230001	参数错误	修改参数后重试
500	1230003	内部错误	请稍后重试
403	1230002	无权限	成为公共邮箱成员后调用该接口