更新群公告信息

PATCH

/open-apis/im/v1/chats/{chat_id}/announcement

自建应用商店应用

更新会话中的群公告信息，更新公告信息的格式和更新云文档格式相同。

注意事项：

应用需要开启机器人能力

机器人或授权用户必须在群里

操作者需要拥有群公告文档的阅读权限

获取内部群信息时，操作者须与群组在同一租户下

若群开启了仅群主和群管理员可编辑群信息配置，群主/群管理员或创建群组且具备更新应用所创建群的群信息权限的机器人，可更新群公告

若群未开启仅群主和群管理员可编辑群信息配置，所有成员可以更新群公告

错误码

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	232010	Operator and chat can NOT be in different tenants.	操作者和被操作的群组应该在同一租户下。
400	232011	Operator can NOT be out of the chat.	操作者需要在群组中。
400	232018	Updating announcement failed.	更新公告失败，请确认错误具体信息，可参考文档编辑文档内容。
400	232019	The request has been rate limited.	触发群限流，请控制请求的速度，详情参见频控策略。
400	232025	Bot ability is not activated.	应用需要开启机器人能力。
400	232066	The operator does not have the doc permission.	操作者没有文档的阅读权限，请添加文档权限后重试。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://open.feishu.cn/open-apis/im/v1/chats/oc_5ad11d72b830411d72b836c20/announcement' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "revision": "12",
    "requests": [
        "{\"requestType\":\"InsertBlocksRequestType\",\"insertBlocksRequest\":{\"payload\":\"{\\\"blocks\\\":[{\\\"type\\\":\\\"paragraph\\\",\\\"paragraph\\\":{\\\"elements\\\":[{\\\"type\\\":\\\"textRun\\\",\\\"textRun\\\":{\\\"text\\\":\\\"ylyyyyyDocs API Sample Content\\\",\\\"style\\\":{}}}],\\\"style\\\":{}}}]}\",\"location\":{\"zoneId\":\"0\",\"index\":0, \"endOfZone\": true}}}"
    ]
}'

响应示例

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

请求参数

Path 参数

chat_id

必需

待修改公告的群 ID，详情参见群ID 说明注意：不支持P2P单聊示例值："oc_5ad11d72b830411d72b836c20"

示例值:

oc_5ad11d72b830411d72b836c20

Header 参数

Authorization

string

必需

tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560"

默认值:

Bearer {{access_token}}

Content-Type

string

必需

固定值："application/json; charset=utf-8"

默认值:

application/json; charset=utf-8

Body 参数application/json

revision

string

必需

文档当前版本号 int64 类型，获取群公告信息接口会返回注意：传入的版本号和最新版本号的差距不能超过100 示例值："12"

requests

array[string]

必需

修改文档请求的序列化字段更新公告信息的格式和更新云文档格式相同示例值：{"requestType":"InsertBlocksRequestType","insertBlocksRequest":{"payload":"{"blocks":[{"type":"paragraph","paragraph":{"elements":[{"type":"textRun","textRun":{"text":"ylyyyyyDocs API Sample Content","style":{}}}],"style":{}}}]}","location":{"zoneId":"0","index":0, "endOfZone": true}}}

示例