Skip to content

更新评论

更新一条评论。

更新时,将update_fields字段中填写所有要修改的评论的字段名,同时在comment字段中填写要修改的字段的新值即可。更新接口规范详情见功能概述中的“ 关于资源的更新”章节。

目前只支持更新评论的"conent"字段。

Tip: 更新评论需要评论归属任务的读取权限,并且只能更新自己创建的评论。详情见任务功能概述中的“任务是如何鉴权的?”章节。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/task/v2/comments/:comment_id
HTTP MethodPATCH
接口频率限制1000 次/分钟、50 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用task:comment:write 查看、创建、更新、删除任务评论

请求头

名称类型必填描述
Authorizationstringtenant_access_tokenuser_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token
Content-Typestring固定值:"application/json; charset=utf-8"

路径参数

名称类型描述
comment_idstring要更新的评论ID
示例值:"7198104824246747156"
数据校验规则
- 最大长度:100 字符

查询参数

名称类型必填描述
user_id_typestring用户 ID 类型
示例值:open_id
默认值open_id

请求体

名称类型必填描述
commentinput_comment要更新的评论数据。
  └ contentstring要更新的评论内容。如果更新该字段,不允许设为空,最大支持3000个utf8字符。
示例值:"举杯邀明月,对影成三人"
数据校验规则
- 最大长度:10000 字符
update_fieldsstring\[\]要更新的字段,支持
- content: 评论内容
示例值:["content"]

请求体示例

json
{
    "comment": {
        "content": "举杯邀明月,对影成三人"
    },
    "update_fields": [
        "content"
    ]
}

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ commentcomment更新后的评论
    └ idstring评论id
    └ contentstring评论内容
    └ creatormember评论创建人
      └ idstring表示member的id
      └ typestring成员的类型
      └ rolestring成员角色
    └ reply_to_comment_idstring被回复评论的id。如果不是回复评论,则为空。
    └ created_atstring评论创建时间戳(ms)
    └ updated_atstring评论更新时间戳(ms)
    └ resource_typestring任务关联的资源类型
    └ resource_idstring任务关联的资源ID

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "comment": {
            "id": "7197020628442939411",
            "content": "这是一条评论",
            "creator": {
                "id": "ou_2cefb2f014f8d0c6c2d2eb7bafb0e54f",
                "type": "user",
                "role": "creator"
            },
            "reply_to_comment_id": "7166825117308174356",
            "created_at": "1675742789470",
            "updated_at": "1675742789470",
            "resource_type": "task",
            "resource_id": "ccb55625-95d2-2e80-655f-0e40bf67953f"
        }
    }
}

错误码

HTTP状态码错误码描述排查建议
4001470400请求参数错误,比如update_fields中填写了不支持的字段名。错误原因见返回的msg提示的信息。
4041470404要更新的评论不存在或已删除。确认要更新的评论是否存在或已删除。
5001470500服务器错误。尝试重试调用。如持续失败,请联系支持人员进行反馈。
4031470403缺少更新评论的权限。更新评论需要评论归属任务的读取权限,并且只能更新自己发出的评论。详情见任务功能概述中的“任务是如何鉴权的?”章节。

内容来源:飞书开放平台 · 自动爬取整理