获取全文评论列表

适用版本>=v7.0.2510.20251023

接口说明： 获取全文评论列表

标签：全文评论

请求说明

字段	值
请求地址	配置域名+/openapi+/v7/documents/{file_id}/comments/{origin_id}/list
HTTP 方法	GET
接口描述	获取全文评论列表,全文评论仅支持两级评论。1.获取根评论时，origin_id默认传0，page_size最大10,每个根目录默认携带俩个子评论。；2.获取子评论时，origin_id传根评论ID，page_size最大100(根评论默认按照id倒叙，子评论按照id正序)
签名方式	KSO-1（配置域名+/openapi不参与签名）
限频策略	无
权限要求	文档管理能力(应用授权) kso.documents.readwrite 文档管理能力(用户授权) kso.documents.readwrite

请求头 (Headers)

属性名	类型	是否必填	描述	可选值
X-Kso-Date	string	是	RFC1123 格式的日期，例: Wed, 23 Jan 2013 06:43:08 GMT	-
X-Kso-Authorization	string	是	KSO-1 签名值，详见《签名方法》	-
Authorization	string	是	授权凭证，格式为：Bearer {access_token}	-

路径参数 (Path)

属性名	类型	是否必填	描述	可选值
file_id	string	是	文件ID	-
origin_id	string	是	根评论id	-

查询参数 (Query)

属性名	类型	是否必填	描述	可选值
page_size	integer	是	分页大小，根评论限制10条	-
page_token	string	否	分页token	-

响应体(Response)

HTTP状态码: 200
响应体格式: application/json

没有可用的数据

响应体示例

{
  "data": {
    "items": [
      {
        "sub_comments": {
          "items": [
            {}
          ],
          "next_page_token": "string",
          "total": 0
        },
        "content": "string",
        "created_by": {
          "avatar": "string",
          "company_id": "string",
          "id": "string",
          "name": "string",
          "type": "user"
        },
        "ctime": 0,
        "id": 0,
        "mtime": 0,
        "origin_id": 0,
        "reply_id": 0,
        "reply_to": {
          "avatar": "string",
          "company_id": "string",
          "id": "string",
          "name": "string",
          "type": "user"
        },
        "status": "normal"
      }
    ],
    "next_page_token": "string",
    "total": 0
  },
  "code": 0,
  "msg": "string"
}