更新群公告信息

更新指定群组中的群公告信息。更新的公告内容格式和更新旧版云文档的格式相同，不支持新版云文档格式。

前提条件

• 应用需要开启机器人能力。
• 调用当前接口的用户或者机器人必须在对应的群组内，且需要拥有群公告文档的阅读权限。

使用限制

• 如果群组配置了 仅群主和群管理员可编辑群信息，则仅有群主、群管理员，或者是创建群组且具有 更新应用所创建群的群信息（im:chat:operate_as_owner） 权限的机器人，可以更新群公告信息。
• 如果群组没有配置 仅群主和群管理员可编辑群信息，则所有群成员可以更新群公告信息。
• 操作内部群时，操作者和被操作的群组必须在同一租户下。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/im/v1/chats/:chat_id/announcement
HTTP Method	PATCH
接口频率限制	1000 次/分钟、50 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	im:chat 获取与更新群组信息 im:chat.announcement:write_only 更新群公告内容

请求头

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

路径参数

名称	类型	描述
chat_id	string	群 ID。获取方式： - 创建群，从返回结果中获取该群的 chat_id。 - 调用获取用户或机器人所在的群列表接口，可以查询用户或机器人所在群的 chat_id。 - 调用搜索对用户或机器人可见的群列表，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 注意：单聊（群类型为 p2p）不支持更新群公告。 示例值："oc_5ad11d72b830411d72b836c20"

请求体

名称	类型	必填	描述
revision	string	是	文档当前版本号 int64 类型，可调用获取群公告信息接口，从返回结果中获取。 注意：传入的版本号和最新版本号的差距不能超过 100。 示例值："12"
requests	string\[\]	否	公告内容，调用接口时该参数必须传入值。公告内容的格式与更新旧版文档内容的格式相同，具体数据结构参考编辑旧版文档内容。 示例值：["{"requestType":"InsertBlocksRequestType","insertBlocksRequest":{"payload":"{\"blocks\":[{\"type\":\"paragraph\",\"paragraph\":{\"elements\":[{\"type\":\"textRun\",\"textRun\":{\"text\":\"Docs API Sample Content\",\"style\":{}}}],\"style\":{}}}]}","location":{\"zoneId\":\"0\",\"index\":0, \"endOfZone\": true}}}"]

请求体示例

{
    "revision": "12",
    "requests": [
        "{\"requestType\":\"InsertBlocksRequestType\",\"insertBlocksRequest\":{\"payload\":\"{\\\"blocks\\\":[{\\\"type\\\":\\\"paragraph\\\",\\\"paragraph\\\":{\\\"elements\\\":[{\\\"type\\\":\\\"textRun\\\",\\\"textRun\\\":{\\\"text\\\":\\\"Docs API Sample Content\\\",\\\"style\\\":{}}}],\\\"style\\\":{}}}]}\",\"location\":{\"zoneId\":\"0\",\"index\":0, \"endOfZone\": true}}}"
    ]
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {}
}

错误码

HTTP状态码	错误码	描述	排查建议
400	232001	Your request contains an invalid request parameter.	参数错误，参考接口文档提供的参数描述，检查输入参数是否有误。
400	232002	No Permission: Only chat owner or admin can edit chat information in the current situation.	当前只允许群组的群主或群管理员更新群信息。
400	232003	Chat announcement can NOT be found in chat information.	群公告信息异常。
400	232009	Your request specifies a chat which has already been dissolved.	群组已被解散，无法操作。
400	232010	Operator and chat can NOT be in different tenants.	操作内部群时，操作者和被操作的群组必须在同一租户下。请检查当前调用身份是否和群组属于同一租户。
400	232011	Operator can NOT be out of the chat.	操作者不在群组中。你需要将当前调用 API 的应用或用户加入待操作的群组后重试。
400	232018	Updating announcement failed.	更新公告失败，请确认错误具体信息，可参考文档编辑旧版文档内容，核对数据结构是否存在问题。
400	232019	The request has been rate limited.	触发群限流，请控制请求的速度，详情参见频控策略。
400	232024	Users do not have the visibility of the app, or the operator does not have collaboration permissions with the target users.	机器人对用户没有可见性，或操作者与用户间没有协作权限。 - 如果是机器人对用户没有可见性，需要在开发者后台 > 应用详情页 > 应用发布 > 版本管理与发布 编辑应用对用户的可见性并发布应用。具体操作参考配置应用可用范围。 - 如果是操作者与用户之间没有协作权限，请检查是否与目标用户有协作权限，如屏蔽、未添加为联系人等。
400	232025	Bot ability is not activated.	应用未启用机器人能力。你需要登录开发者后台，在应用详情页的 应用能力 > 添加应用能力 页面内，添加 机器人 能力，并发布应用使配置生效。具体操作参见机器人能力。
400	232033	The operator or invited bots does NOT have the authority to manage external chats without the scope.	当前被操作的群为外部群，暂不支持操作外部群。只有开启对外共享能力的机器人支持外部群，详情参见机器人支持外部群和外部用户单聊。
400	232034	The app is unavailable or inactivated by the tenant.	应用在本租户下未安装或未启用。需要先安装应用，再使用应用调用接口。
400	232066	The operator does not have the doc permission.	操作者没有文档的阅读权限。你需要为当前调用 API 的应用或用户添加文档阅读权限后重试。
400	232097	Unable to operate docx type chat announcement.	本接口无法操作 docx 类型的群公告，请参考"更新新版本群公告"接口。

更多错误码信息，参见通用错误码。