Skip to content

删除评论

删除某审批实例下的一条评论或评论回复(不包含审批同意、拒绝、转交等附加的理由或意见),删除后在审批中心的审批实例内不再显示评论内容,而是显示 评论已删除

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/approval/v4/instances/:instance_id/comments/:comment_id
HTTP MethodDELETE
接口频率限制1000 次/分钟、50 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可approval:approval 查看、创建、更新、删除审批应用相关信息 approval:instance.comment 查看、创建、更新、删除原生审批评论相关信息
字段权限要求> Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

名称类型必填描述
Authorizationstringtenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token

路径参数

名称类型描述
instance_idstring审批实例 Code。获取方式:
- 创建审批实例 后,从返回结果中获取审批实例 Code。 - 调用批量获取审批实例 ID,获取指定审批定义内的审批实例 Code。 - 调用查询实例列表,设置过滤条件查询指定的审批实例 Code。
说明:支持传入自定义审批实例 ID。
示例值:"6A123516-FB88-470D-A428-9AF58B71B3C0"
comment_idstring评论 ID。获取方式:
- 调用创建评论成功会返回评论 ID。 - 调用获取评论接口,获取评论 ID。
示例值:"7081516627711606803"

查询参数

名称类型必填描述
user_id_typestring用户 ID 类型
示例值:user_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
user_idstring用户 ID,ID 类型与 user_id_type 取值一致。
示例值:ou_806a18fb5bdf525e38ba219733bdbd73

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ comment_idstring被删除的评论 ID。

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "comment_id": "7081516627711606803"
    }
}

错误码

HTTP状态码错误码描述排查建议
4001390001param is invalid参数错误。排查方案: - 根据接口文档的参数说明,检查请求时传入的参数是否正确。 - 如果传入的有表单参数(form),则需要检查该参数内传入的表单控件数据是否正确。如果报错信息内包含控件 ID(如 控件= widget17261088448220001),可以调用查看指定审批定义或者获取单个审批实例详情接口,获取响应参数 form 值,检索有问题的控件 ID,然后检查该控件的配置是否正确。

更多错误码信息,参见通用错误码

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