Skip to content

删除群公告中的块

指定需要操作的块,删除其指定范围的子块。如果操作成功,接口将返回应用删除操作后的群公告版本号。

Tip: 群公告频率限制:单篇群公告并发编辑上限为每秒 3 次,超过该频率限制,接口将返回 HTTP 状态码 429,编辑操作包括:

  • 创建块
  • 批量更新块
  • 删除块

当请求被限频,应用需要处理限频状态码,并使用指数退避算法或其它一些频控策略降低对 API 的调用速率。

前提条件

  • 应用需要开启机器人能力
  • 调用当前接口的用户或者机器人必须在对应的群组内。
  • 操作内部群的群公告时,请确保当前调用身份(tenant_access_token 或 user_access_token)与对应群组在同一租户下。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/docx/v1/chats/:chat_id/announcement/blocks/:block_id/children/batch_delete
HTTP MethodDELETE
接口频率限制5 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用im:chat.announcement:write_only 更新群公告内容

请求头

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

路径参数

名称类型描述
chat_idstring群 ID。获取方式:
- 创建群,从返回结果中获取该群的 chat_id。 - 调用获取用户或机器人所在的群列表接口,可以查询用户或机器人所在群的 chat_id。 - 调用搜索对用户或机器人可见的群列表,可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。
注意:单聊(群类型为 p2p)不支持获取群公告。
示例值:"oc_5ad11d72b830411d72b836c20"
block_idstring父 Block 的唯一标识。你可通过调用获取群公告所有块接口获取块的 block_id。
注意
- 此接口不支持删除表格(Table)的行列和删除分栏(Grid)的分栏列。你需通过批量更新块的内容接口完成相关操作。
- 此接口不支持删除表格单元格(Table Cell)、分栏列(Grid Column)和高亮块(Callout)的全部子块。
示例值:"doxcnO6UW6wAw2qIcYf4hZpFIth"

查询参数

名称类型必填描述
revision_idint要操作的群公告版本。-1 表示群公告最新版本。群公告创建后,版本为 1。你需确保你已拥有群公告的编辑权限。你可通过调用获取群公告基本信息获取群公告的最新 revision_id
示例值:-1
默认值-1
数据校验规则
- 最小值:-1
client_tokenstring操作的唯一标识,与接口返回值的 client_token 相对应,用于幂等的进行更新操作。此值为空表示将发起一次新的请求,此值非空表示幂等的进行更新操作。
示例值:fe599b60-450f-46ff-b2ef-9f6675625b97

请求体

名称类型必填描述
start_indexint删除的起始索引(操作区间左闭右开)
示例值:0
数据校验规则
- 最小值:0
end_indexint删除的末尾索引(操作区间左闭右开)
示例值:1
数据校验规则
- 最小值:1

请求体示例

json
{
    "start_index": 0,
    "end_index": 1
}

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ revision_idint当前删除操作成功后群公告的版本号
  └ client_tokenstring操作的唯一标识,更新请求中使用此值表示幂等的进行此次更新

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "revision_id": 1,
        "client_token": "fe599b60-450f-46ff-b2ef-9f6675625b97"
    }
}

错误码

HTTP状态码错误码描述排查建议
4001770001invalid param确认传入的参数是否合法
4041770002not found群 ID chat_id 不存在。请确认群是否被解散或 chat_id 是否填写正确。
4001770003resource deleted确认资源是否已被删除
4001770004too many blocks in document确认群公告中 Block 数量是否超上限
4001770005too deep level in document确认群公告 Block 层级是否超上限
4001770006schema mismatch确认群公告结构是否合法
4001770007too many children in block确认指定 Block 的 Children 数量是否超上限
4001770008too big file size确认上传的文件尺寸是否超上限
4001770010too many table column确认表格列数是否超上限,上限 100 列
4001770011too many table cell确认表格单元格数量是否超上限,上限 2000 个单元格
4001770012too many grid column确认 Grid 列数量是否超上限,上限 10 列
4001770013relation mismatch图片、文件等资源的关联关系不正确。请确保在创建图片、文件块时,同时上传了相关图片或文件素材至对应的群公告块中。
4001770014parent children relation mismatch确认 Block 父子关系是否正确
4001770015single edit with multi document确认 Block 所属群公告与指定的群公告是否相同
4001770029block not support to create确认指定 Block 是否支持创建
4001770019repeated blockID in document确认群公告中的 BlockID 是否有重复
4001770020operation denied on copying document确认 Document 是否正在创建副本中
4001770021too old document确认指定的群公告版本(revision_id)是否过旧。指定的版本号与群公告最新版本号差值不能超过 1000
4001770041open schema mismatch确认块父子关系是否合法
4001770024invalid operation确认操作是否合法
4001770025operation and block not match确认指定 Block 应用对应操作是否合法
4001770026row operation over range确认行操作下标是否越界
4001770027column operation over range确认列操作下标是否越界
4001770028block not support create children确认指定 Block 添加 Children 是否合法
4001770030invalid parent children relation确认指定操作其父子关系是否合法
4001770031block not support to delete children确认指定 Block 是否支持删除 Children
4001770033raw content size exceed limited纯文本内容大小超过限制
4001770034operation count exceed limited当前请求中涉及单元格个数过多,请拆分成多次请求
4001770035resource count exceed limit当前请求中资源的数目超限,请拆分成多次请求。各类资源上限为:ChatCard 200 张,File 200 个,MentionDoc 200 个,MentionUser 200 个,Image 20 张,ISV 20 个,Sheet 5 篇,Bitable 5 篇。
4001770038resource not found未查询到插入的资源或资源无权限插入,请检查资源标识是否正确。
4001772001Chat announcement can NOT be found in chat information.群公告信息异常。请重试,若仍无法解决请咨询技术支持
4001772002Operator and chat can NOT be in different tenants.操作内部群时,操作者和被操作的群组必须在同一租户下。请检查当前调用身份是否和群组属于同一租户。
4001772003Operator can NOT be out of the chat.操作者不在群组中。你需要将当前调用 API 的应用或用户加入待操作的群组后重试。
4001772004The operator or invited bots does NOT have the authority to manage external chats without the scope.当前被操作的群为外部群,暂不支持操作外部群。
4001772025Bot ability is not activated.应用未启用机器人能力。你需要登录开发者后台,在应用详情页的 应用能力 > 添加应用能力 页面内,添加 机器人 能力,并发布应用使配置生效。具体操作参见机器人能力
4001772006announcement type is not supported除「获取群公告基本信息」接口,其它新版群公告接口均无法操作 doc 类型的群公告,如需操作 doc 类型群公告请参考「旧版群公告」接口。
4001772005No Permission: Only chat owner or admin can edit chat information in the current situation.当前只允许群组的群主或群管理员更新群信息。
4001772034The app is unavailable or inactivated by the tenant.应用在本租户下未安装或未启用。需要先安装应用,再使用应用调用接口。
4031770032forbidden当前的操作者没有群公告的编辑权限。解决方案: - 方案一:调用指定群管理员接口,将当前操作者置为群管理员,然后重试。 - 方案二:在 飞书客户端 > 群组 > 设置 > 群管理 中,将 谁可以编辑群信息 设置为 所有群成员,然后重试。 对于创建和更新相关接口,你还需要确认: - 当前调用身份是否有 MentionDoc 即 @文档 中文档的阅读权限 - MentionUser 即 @用户 中的用户是否在职且与当前调用身份互为联系人 - 当前调用身份是否具有群卡片的查看和分享权限 - 当前调用身份是否具有访问指定 Wiki 即知识库子目录的权限 - 当前调用身份是否具有 OKR、ISV、Add-Ons 等文档块的查看权限
5001771001server internal error服务器内部错误。请重试,若仍无法解决请咨询技术支持
5001771002gateway server internal error网关服务内部错误。请重试,若仍无法解决请咨询技术支持
5001771003gateway marshal error网关服务解析错误。请重试,若仍无法解决请咨询技术支持
5001771004gateway unmarshal error网关服务反解析错误。请重试,若仍无法解决请咨询技术支持
5031771005system under maintenance系统服务正在维护中

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