# 获取评论列表
该接口用于查询任务评论列表，支持分页，最大值为100。
## 请求
基本 |
---|---
HTTP URL | https://open.feishu.cn/open-apis/task/v1/tasks/:task_id/comments
HTTP Method | GET
接口频率限制 | [1000 次/分钟、50 次/秒](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
支持的应用类型 | Custom App、Store App
权限要求
**调用该 API 所需的权限。开启其中任意一项权限即可调用**
开启任一权限即可 | 查看、创建、编辑和删除飞书任务（历史版本）(task:task)
查看任务详情(task:task:readonly)
字段权限要求 | **注意事项**：该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请
获取用户 user ID(contact:user.employee_id:readonly)
### 请求头
名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | `tenant_access_token`
或
`user_access_token`
**值格式**："Bearer `access_token`"
**示例值**："Bearer u-7f1bcd13fc57d46bac21793a18e560"
[了解更多：如何选择与获取 access token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use)
### 路径参数
名称 | 类型 | 描述
---|---|---
task_id | string | 任务id
**示例值**：""83912691-2e43-47fc-94a4-d512e03984fa""
### 查询参数
名称 | 类型 | 必填 | 描述
---|---|---|---
page_size | int | 否 | 分页大小
**示例值**：10
**数据校验规则**：
- 最大值：`100`
page_token | string | 否 | 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果
**示例值**："MTYzMTg3ODUxNQ=="
list_direction | int | 否 | 评论排序标记，可按照评论时间从小到大查询，或者评论时间从大到小查询，不填默认按照从小到大
**示例值**：0
**可选值有**：
- 0：按照回复时间从小到大查询
- 1：按照回复时间从大到小查询
**默认值**：`0`
user_id_type | string | 否 | 用户 ID 类型
**示例值**：open_id
**可选值有**：
- open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。[了解更多：如何获取 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)
- union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。[了解更多：如何获取 Union ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id)
- user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。[了解更多：如何获取 User ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id)
**默认值**：`open_id`
**当值为 `user_id`，字段权限要求**：
获取用户 user ID(contact:user.employee_id:readonly)
## 响应
### 响应体
名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
items | comment\[\] | 返回的评论列表
content | string | 评论内容。
评论内容和富文本评论内容同时存在时只使用富文本评论内容。
parent_id | string | 评论的父ID，创建评论时若不为空则为某条评论的回复，若为空则不是回复
id | string | 评论ID，由飞书服务器发号
create_milli_time | string | 评论创建的时间戳，单位为毫秒，用于展示，创建时不用填写
rich_content | string | 富文本评论内容。语法格式参见[Markdown模块](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/task-v1/markdown-module)
creator_id | string | 评论的创建者 ID。在创建评论时无需填充该字段
page_token | string | 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
has_more | boolean | 是否还有更多项
### 响应体示例
```json
{
"code": 0,
"data": {
"has_more": false,
"items": [
{
"content": "评论2",
"id": "7104224757005533212",
"parent_id": "0",
"create_milli_time": "1656483428000"
},
{
"content": "评论1",
"id": "7104224731582169116",
"parent_id": "0",
"create_milli_time": "1656483428000"
}
],
"page_token": "LTE="
},
"msg": ""
}
```
### 错误码
HTTP状态码 | 错误码 | 描述 | 排查建议
---|---|---|---
403 | 1470403 | The identity token is incorrect. It should be either user_access_token or tenant_access_token. | 发起请求方的身份token不正确，需要为UserAccessToken或TenantAccessToken其中一种
500 | 1470734 | failed to get comment | 一般是获取评论时系统内部逻辑处理出现问题，可根据具体错误进行分析，无法解决时请找相关服务的同学处理
400 | 1470432 | have no permission to get task | 没有获取任务的权限，需要检查当前发起请求的对象是否有权限
400 | 1470421 | page_size exceed 100 | 分页大小超过最大值100，需要减小page_size的值
400 | 1470422 | failed to parse page_token | 解析分页标识失败，需要检查分页标识是否合法
400 | 1470602 | Invalid task id. | 请检查任务的 id 是否合法
404 | 1470733 | comment not found | 一般是回复评论时传的parent_id有问题