分页获取文档评论

GET

https://open.feishu.cn/open-apis/drive/v1/files/{file_token}/comments

该接口用于根据文档 token 分页获取文档评论。

错误码

HTTP状态码	错误码	描述	排查建议
400	1069301	fail	重试，若稳定失败请联系相关业务方oncall人员
400	1069302	param error	检查参数有效性
403	1069303	forbidden	检查是否有待评论文档的评论权限
400	1069308	exceeded limit	评论数据超过上限限制，详情请咨询客服
400	1069304	docs had been deleted	检查待评论文档是否已被删除
404	1069307	not exist	检查待评论文档是否能正常访问、检查评论内容at人或云文档是否存在
400	1069399	internal error	重试，若稳定失败请联系相关业务方oncall人员

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://open.feishu.cn/open-apis/drive/v1/files/文档token/comments?file_type' \
--header 'Authorization;'

响应示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "has_more": true,
    "page_token": "6916106822734512356",
    "items": [
      {
        "comment_id": "6916106822734512356",
        "user_id": "ou_cc19b2bfb93f8a44db4b4d6eababcef",
        "create_time": 1610281603,
        "update_time": 1610281603,
        "is_solved": false,
        "solved_time": 1610281603,
        "solver_user_id": "null",
        "has_more": false,
        "page_token": "6916106822734512356",
        "is_whole": true,
        "quote": "划词评论引用内容",
        "reply_list": {
          "replies": [
            {
              "reply_id": "6916106822734512356",
              "user_id": "ou_cc19b2bfb93f8a44db4b4d6eab2abcef",
              "create_time": 1610281603,
              "update_time": 1610281603,
              "content": {
                "elements": [
                  {
                    "type": "text_run",
                    "text_run": {
                      "text": "comment text"
                    },
                    "docs_link": {
                      "url": "https://bytedance.feishu.cn/docs/doccnHh7U87HOFpii5u5Gabcef"
                    },
                    "person": {
                      "user_id": "ou_cc19b2bfb93f8a44db4b4d6eababcef"
                    }
                  }
                ]
              },
              "extra": {
                "image_list": [
                  "xfsfseewewabcef"
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

请求参数

Path 参数

file_token

string

必需

XIHSdYSI7oMEU1xrsnxc8fabcef

示例值:

文档token

Query 参数

file_type

string

必需

文档类型示例值："doc" 可选值有： doc：文档类型 sheet：电子表格类型 file：文件类型 docx：新版文档类型

is_whole

string

是否全文评论

可选

示例值:

false

is_solved

string

是否已解决（可选）

可选

示例值:

false

page_token

string

可选

分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果

示例值:

7153511712153412356

page_size

string

可选

分页大小，数据校验规则：最大值：100

示例值:

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，字段权限要求：获取用户 user ID

Header 参数

Authorization

string

必需

tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560"

默认值:

Bearer {{access_token}}

Content-Type

string

必需

固定值："application/json; charset=utf-8"

默认值:

application/json; charset=utf-8

返回响应

🟢200成功

application/json

Body

code

integer

必需

错误码，非 0 表示失败

msg

string

错误描述

必需

data

object

必需

has_more

boolean

是否还有更多项

必需

page_token

string

必需

分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token

items

array [object {12}]

评论列表

必需

修改于 2023-01-13 08:05:44

更新云文档权限设置

添加评论

分页获取文档评论

错误码#

请求参数

返回响应

错误码