Skip to content

创建评论

该接口用于创建和回复任务的评论。当parent_id字段为0时,为创建评论;当parent_id不为0时,为回复某条评论。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/task/v1/tasks/:task_id/comments
HTTP MethodPOST
接口频率限制1000 次/分钟、50 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用task:comment 查看、创建、修改、删除任务评论(历史版本)
字段权限要求> Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

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

路径参数

名称类型描述
task_idstring任务 ID
示例值:"83912691-2e43-47fc-94a4-d512e03984fa"

查询参数

名称类型必填描述
user_id_typestring用户 ID 类型
示例值:open_id
可选值有
- open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多:如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的,在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID,应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多:如何获取 Union ID? - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内,一个用户的 User ID 在所有应用(包括商店应用)中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多:如何获取 User ID?
默认值open_id
当值为 user_id,字段权限要求contact:user.employee_id:readonly 获取用户 user ID

请求体

名称类型必填描述
contentstring评论内容。
> Info: 评论内容和富文本评论内容同时存在时只使用富文本评论内容。
示例值:"举杯邀明月,对影成三人"
数据校验规则
- 长度范围:065536 字符
parent_idstring评论的父ID,创建评论时若不为空则为某条评论的回复,若为空则不是回复
示例值:"6937231762296684564"
create_milli_timestring评论创建的时间戳,单位为毫秒,用于展示,创建时不用填写
示例值:"1657075055135"
rich_contentstring富文本评论内容。语法格式参见Markdown模块
示例值:"举杯邀明月,对影成三人"
数据校验规则
- 长度范围:065536 字符

请求体示例

json
{
    "content":"多喝水,少吃肉",
    "rich_content":"富文本评论[飞书开放平台](https://open.feishu.cn)",
    "parent_id":0
}

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ commentcomment返回创建好的任务评论
    └ contentstring评论内容。
> Info: 评论内容和富文本评论内容同时存在时只使用富文本评论内容。
    └ parent_idstring评论的父ID,创建评论时若不为空则为某条评论的回复,若为空则不是回复
    └ idstring评论ID,由飞书服务器发号
    └ create_milli_timestring评论创建的时间戳,单位为毫秒,用于展示,创建时不用填写
    └ rich_contentstring富文本评论内容。语法格式参见Markdown模块
    └ creator_idstring评论的创建者 ID。在创建评论时无需填充该字段

响应体示例

json
{
    "code": 0,
    "data": {
        "comment": {
            "content": "多喝水,少吃肉",
            "rich_content":"富文本评论飞书开放平台\n",
            "id": "6997680617668214803",
            "parent_id": "0"
        }
    },
    "msg": "success"
}

错误码

HTTP状态码错误码描述排查建议
4031470403The identity token is incorrect. It should be either user_access_token or tenant_access_token.发起请求方的身份token不正确,需要为UserAccessToken或TenantAccessToken其中一种
5001470730failed to create comment一般是创建评论时系统内部逻辑处理出现问题,可根据具体错误进行分析,无法解决时请找相关服务的同学处理
4001470417failed to parse rich_content解析富文本失败,请检查富文本是否格式正确
4001470418comment is empty评论的内容为空,需要填充评论内容

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