Skip to content

订阅用户云文档事件

订阅用户云文档的各类通知事件,调用后目前可获取接收者视角的云文档评论、回复添加事件 ,未来 还会陆续扩充其它通知事件。

注意事项

仅用户身份订阅“用户云文档事件”时,需要调用该接口。应用身份无需调用。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/drive/v1/user/subscription
HTTP MethodPOST
接口频率限制10 次/分钟
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用docs:event:subscribe 订阅云文档事件

请求头

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

请求体

名称类型必填描述
event_typestring事件类型
路由到 云文档事件列表,当前仅支持一种事件
可选值:
drive.notice.comment_add_v1:添加评论、回复通知事件
示例值:"drive.notice.comment_add_v1"

请求体示例

json
{
    "event_type": "drive.notice.comment_add_v1"
}

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--

响应体示例

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

错误码

HTTP状态码错误码描述排查建议
5001069601fail重试,若稳定失败请联系技术支持
4001069602param error检查参数有效性

内容来源:飞书开放平台 · 自动爬取整理