Skip to content

创建评论

为一个任务创建评论,或者回复该任务的某个评论。

若要创建一个回复评论,需要在创建时设置reply_to_comment_id字段。被回复的评论和新建的评论必须属于同一个任务。

Tip: 对任务进行评论时需要评论的读取权限。详情见清单功能概述中的“清单是如何鉴权的?“章节。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/task/v2/comments
HTTP MethodPOST
接口频率限制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"

查询参数

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

请求体

名称类型必填描述
contentstring评论内容。不允许为空,最长3000个utf8字符。
示例值:"这是一条评论。"
reply_to_comment_idstring回复给评论的评论ID。如果不填写表示创建非回复评论。
示例值:"6937231762296684564"
数据校验规则
- 最大长度:20 字符
resource_typestring评论归属的资源类型,目前只支持任务“task”,默认为"task"。
示例值:"task"
默认值task
resource_idstring评论归属的资源ID。当归属资源类型为"task"时,这里应填写任务的GUID。
示例值:"ccb55625-95d2-2e80-655f-0e40bf67953f"
数据校验规则
- 最大长度:100 字符

请求体示例

json
{
    "content": "这是一条评论。",
    "reply_to_comment_id": "6937231762296684564",
    "resource_type": "task",
    "resource_id": "ccb55625-95d2-2e80-655f-0e40bf67953f"
}

响应

响应体

名称类型描述
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参数错误,如评论内容过长。错误原因见返回的msg提示的信息。
4041470404要评论的资源不存在或已删除。检查要评论的资源是否存在或已被删除。
5001470500服务器错误。尝试重试调用。如持续失败,请联系支持人员进行反馈。
4031470403缺少评论权限。对任务进行评论时需要评论的读取权限。详情见清单功能概述中的“清单是如何鉴权的?“章节。

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