更新回复的内容
更新云文档中的某条回复的内容。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/drive/v1/files/:file_token/comments/:comment_id/replies/:reply_id |
| HTTP Method | PUT |
| 接口频率限制 | 1000 次/分钟、50 次/秒 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | docs:doc 查看、评论、编辑和管理文档 docs:doc:readonly 查看、评论和导出文档 docs:document.comment:update 修改云文档中的评论 docs:document.comment:write_only 回复、修改、删除云文档中的评论 drive:drive 查看、评论、编辑和管理云空间中所有文件 drive:drive:readonly 查看、评论和下载云空间中所有文件 sheets:spreadsheet 查看、评论、编辑和管理电子表格 sheets:spreadsheet:readonly 查看、评论和导出电子表格 |
| 字段权限要求 | > Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 或 user_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
file_token | string | 文档 Token 示例值:"doxbcdl03Vsxhm7Qmnj110abcef" |
comment_id | string | 评论 ID 示例值:"6916106822734578184" |
reply_id | string | 回复 ID 示例值:"6916106822734594568" |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
file_type | string | 是 | 云文档类型 示例值:doc 可选值有: - doc: 旧版文档,已不推荐使用 - docx: 新版文档 - sheet: 表格 - file: 文件 - slides: 幻灯片 |
user_id_type | string | 否 | 用户 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 |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
content | reply_content | 是 | 回复内容 |
└ elements | reply_element\[\] | 是 | 回复的内容 |
└ type | string | 是 | 回复的内容元素 示例值:"text_run" 可选值有: - text_run: 普通文本 - docs_link: at 云文档链接 - person: at 联系人 |
└ text_run | text_run | 否 | 文本内容 |
└ text | string | 是 | 回复 普通文本 示例值:"comment text" |
└ docs_link | docs_link | 否 | 添加云文档链接 |
└ url | string | 是 | 回复 at 云文档 示例值:"https://example.feishu.cn/docs/doccnHh7U87HOFpii5u5Gabcef" |
└ person | person | 否 | 添加用户的 user_id |
└ user_id | string | 是 | 添加用户的 user_id 以@用户。 示例值:"ou_cc19b2bfb93f8a44db4b4d6eababcef" |
请求体示例
json
{
"content": {
"elements": [
{
"type": "text_run",
"text_run": {
"text": "comment text"
},
"docs_link": {
"url": "https://example.feishu.cn/docs/doccnHh7U87HOFpii5u5Gabcef"
},
"person": {
"user_id": "ou_cc19b2bfb93f8a44db4b4d6eababcef"
}
}
]
}
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 1069301 | fail | 重试,若稳定失败请联系相关业务方oncall人员 |
| 400 | 1069302 | param error | 检查参数有效性 |
| 403 | 1069303 | forbidden | 检查是否有待评论云文档的评论权限 |
| 400 | 1069304 | docs had been deleted | 检查待评论云文档是否已被删除 |
| 400 | 1069305 | docs not exist | 检查待评论云文档是否能正常访问 |
| 400 | 1069306 | content review not pass | 排查评论内容是否存在不合法内容 |
| 404 | 1069307 | not exist | 检查待评论云文档是否能正常访问、检查评论内容at人或云文档是否存在 |
| 400 | 1069308 | exceeded limit | 评论数据超过上限限制,详情请咨询客服 |
| 400 | 1069399 | internal error | 重试,若稳定失败请联系相关业务方oncall人员 |
