服务端 API/审批/原生审批评论/获取评论
# 获取评论

根据 Instance Code 获取某个审批实例下的全部评论与评论回复（不包含审批同意、拒绝、转交等附加的理由或意见）。

## 请求

基本 |  
---|---
HTTP URL | https://open.larksuite.com/open-apis/approval/v4/instances/:instance_id/comments
HTTP Method | GET
支持的应用类型 | Custom App、Store App
权限要求<br>**调用该 API 所需的权限。开启其中任意一项权限即可调用**<br>开启任一权限即可 | 查看、创建、更新、删除审批应用相关信息(approval:approval)<br>访问审批应用(approval:approval:readonly)
字段权限要求 | **注意事项**：该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请<br>获取用户 user ID(contact:user.employee_id:readonly)

### 请求头

名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | `tenant_access_token`<br>**值格式**："Bearer `access_token`"<br>**示例值**："Bearer t-7f1bcd13fc57d46bac21793a18e560"<br>[了解更多：如何选择与获取 access token](https://open.larksuite.com/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use)

### 路径参数

名称 | 类型 | 描述
---|---|---
instance_id | string | 审批实例code（或者租户自定义审批实例ID）<br>**示例值**："6A123516-FB88-470D-A428-9AF58B71B3C0"

### 查询参数

名称 | 类型 | 必填 | 描述
---|---|---|---
user_id_type | string | 否 | 用户 ID 类型<br>**示例值**："open_id"<br>**可选值有**：<br>- open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。[了解更多：如何获取 Open ID](https://open.larksuite.com/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)<br>- union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。[了解更多：如何获取 Union ID？](https://open.larksuite.com/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id)<br>- user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。[了解更多：如何获取 User ID？](https://open.larksuite.com/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id)<br>**默认值**：`open_id`<br>**当值为 `user_id`，字段权限要求**：<br>获取用户 user ID(contact:user.employee_id:readonly)
user_id | string | 是 | 用户ID<br>**示例值**："e5286g26"
page_token | string | 否 | 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果<br>**示例值**："nF1ZXJ5VGhlbkZldGNoCgAAAAAA6PZwFmUzSldvTC1yU"
page_size | int | 否 | 分页大小<br>**示例值**：10<br>**数据校验规则**：<br>- 最大值：`1000`

## 响应

### 响应体

名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
comments | comment\[\] | 评论数据列表
id | string | 评论ID
content | string | 评论内容
create_time | string | 评论创建时间
update_time | string | 评论更新时间
is_delete | int | 是否删除，0:未删除，1:已删除
replies | comment_reply\[\] | 评论的回复
id | string | 评论ID
content | string | 评论内容
create_time | string | 评论创建时间
update_time | string | 评论更新时间
is_delete | int | 是否删除，0:未删除，1:已删除
at_info_list | comment_at_info\[\] | 评论中艾特人信息
user_id | string | 被艾特人的ID
name | string | 被艾特人的姓名
offset | string | 被艾特人在评论中的位置，从0开始
commentator | string | 评论创建人
extra | string | 附加字段
at_info_list | comment_at_info\[\] | 评论中艾特人信息
user_id | string | 被艾特人的ID
name | string | 被艾特人的姓名
offset | string | 被艾特人在评论中的位置，从0开始
commentator | string | 评论创建人
extra | string | 附加字段

### 响应体示例
```json
{
    "code": 0,
    "msg": "success",
    "data": {
        "comments": [
            {
                "id": "7081516627711524883",
                "content": "{\"text\":\"x@王某自小程序的评论111我带了附件，而且我艾特了人 \",\"files\":[{\"url\":\"https://xx-xxx-xxx.bytedance.net/lark-approval-attachment/image/20220401/1/d43216ca-93b5-43a8-8a34-23c66820463a.png~tplv-k7bg0smxju-image.image?x-orig-authkey=boeorigin\&x-orig-expires=1650963890\&x-orig-sign=668QhQbRSt6638x2Ws8wFI%2FxqVg%3D#.png\",\"fileSize\":155149,\"title\":\"9a9fedc5cfb01a4a20c715098.png\",\"type\":\"image\"}]}",
                "create_time": "1648801211000",
                "update_time": "1648801211000",
                "is_delete": 1,
                "replies": [
                    {
                        "id": "7081516611634741268",
                        "content": "{\"text\":\"x@张某来自小程序的评论111,这是一条回复\",\"files\":[{\"url\":\"https://xx-xxx-xxx.bytedance.net/lark-approval-attachment/image/20220401/1/d43216ca-93b5-43a8-8a34-23c66820463a.png~tplv-k7bg0smxju-image.image?x-orig-authkey=boeorigin\&x-orig-expires=1650963890\&x-orig-sign=668QhQbRSt6638x2Ws8wFI%2FxqVg%3D#.png\",\"fileSize\":155149,\"title\":\"9a9fedc5cfb01a4a20c715098.png\",\"type\":\"image\"}]}",
                        "create_time": "1648803677000",
                        "update_time": "1648803677000",
                        "is_delete": 0,
                        "at_info_list": [
                            {
                                "user_id": "579fd9c4",
                                "name": "张某",
                                "offset": "1"
                            }
                        ],
                        "commentator": "893g4c45",
                        "extra": "{\"a\":\"a\"}"
                    }
                ],
                "at_info_list": [
                    {
                        "user_id": "579fd9c4",
                        "name": "张某",
                        "offset": "1"
                    }
                ],
                "commentator": "893g4c45",
                "extra": "{\"a\":\"a\"}"
            }
        ]
    }
}
```

### 错误码

HTTP状态码 | 错误码 | 描述 | 排查建议
---|---|---|---
400 | 1390001 | param is invalid | 参数错误