获取云文档的点赞者列表
获取指定云文档的点赞者列表并按点赞时间由近到远分页返回。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/drive/v2/files/:file_token/likes |
| HTTP Method | GET |
| 接口频率限制 | 5 次/秒 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | drive:file.like:readonly 查看云文档的点赞信息 |
| 字段权限要求 | > Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.base:readonly 获取用户基本信息 contact:user.employee_id:readonly 获取用户 user ID contact:contact:access_as_app 以应用身份访问通讯录 contact:contact:readonly 读取通讯录 contact:contact:readonly_as_app 以应用身份读取通讯录 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 或 user_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
file_token | string | 需要查询点赞者列表的云文档 token。点击了解如何获取云文档 Token 示例值:"J6Lddz22AovnqkxWEXBcUJabcef" |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
file_type | string | 是 | 云文档类型,如果该值为空或者与云文档实际类型不匹配,接口会返回失败。 示例值:doc 可选值有: - doc: 旧版文档 - docx: 新版文档 - file: 文件 |
page_size | int | 否 | 分页大小 示例值:10 默认值: 10数据校验规则: - 取值范围: 1 ~ 50 |
page_token | string | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果 示例值:aw7DoMKBFMOGwqHCrcO8w6jCmMOvw6ILeADCvsKNw57Di8O5XGV3LG4_w5HCqhFxSnDCrCzCn0BgZcOYUg85EMOYcEAcwqYOw4ojw5QFwofCu8KoIMO3K8Ktw4IuNMOBBHNYw4bCgCV3U1zDu8K-J8KSR8Kgw7Y0fsKZdsKvW3d9w53DnkHDrcO5bDkYwrvDisOEPcOtVFJ-I03CnsOILMOoAmLDknd6dsKqG1bClAjDuS3CvcOTwo7Dg8OrwovDsRdqIcKxw5HDohTDtXN9w5rCkWo |
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 | \- | - |
└ items | file_like\[\] | 云文档的点赞者列表 |
└ user_id | string | 用户 ID。与查询参数 user_id_type 一致 |
└ last_liked_time | string | 用户最后点赞时间,秒级时间戳 |
└ user_name | string | 用户名字,用户信息被脱敏时此值不会返回 字段权限要求(满足任一): contact:user.base:readonly 获取用户基本信息 contact:contact:access_as_app 以应用身份访问通讯录 contact:contact:readonly 读取通讯录 contact:contact:readonly_as_app 以应用身份读取通讯录 |
└ user_en_name | string | 用户英文名字,用户信息被脱敏时此值不会返回 字段权限要求(满足任一): contact:user.base:readonly 获取用户基本信息 contact:contact:access_as_app 以应用身份访问通讯录 contact:contact:readonly 读取通讯录 contact:contact:readonly_as_app 以应用身份读取通讯录 |
└ user_avatar_url | string | 用户头像,用户信息被脱敏时此值不会返回 字段权限要求(满足任一): contact:user.base:readonly 获取用户基本信息 contact:contact:access_as_app 以应用身份访问通讯录 contact:contact:readonly 读取通讯录 contact:contact:readonly_as_app 以应用身份读取通讯录 |
└ user_is_desensitized | boolean | 用户信息是否脱敏 |
└ page_token | string | 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token |
└ has_more | boolean | 是否还有更多项 |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"items": [
{
"user_id": "ou_3bbe8a09c20e89cce9bff989ed840674",
"last_liked_time": "1690857821",
"user_name": "张三",
"user_en_name": "San Zhang",
"user_avatar_url": "https://foo.icon.com/xxxx",
"user_is_desensitized": false
}
],
"page_token": "aw7DoMKBFMOGwqHCrcO8w6jCmMOvw6ILeADCvsKNw57Di8O5XGV3LG4_w5HCqhFxSnDCrCzCn0BgZcOYUg85EMOYcEAcwqYOw4ojw5QFwofCu8KoIMO3K8Ktw4IuNMOBBHNYw4bCgCV3U1zDu8K-J8KSR8Kgw7Y0fsKZdsKvW3d9w53DnkHDrcO5bDkYwrvDisOEPcOtVFJ-I03CnsOILMOoAmLDknd6dsKqG1bClAjDuS3CvcOTwo7Dg8OrwovDsRdqIcKxw5HDohTDtXN9w5rCkWo",
"has_more": true
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 500 | 1061001 | server internal error | 服务内部错误,请稍后重试,仍然出现可以咨询客服 |
| 400 | 1061002 | invalid params | 请检查请求参数是否正确 |
| 404 | 1061003 | file not found | 请确认指定的云文档是否存在 |
| 403 | 1061004 | no file permission | 无权限获取指定云文档的点赞者记录。请确认当前应用/用户是否有「云文档阅读权限」以及「查看访问者头像和点赞者头像权限」 |
| 400 | 1061007 | file is deleted | 请确认指定的云文档是否已被删除 |
