获取群公告信息

获取指定群组中的群公告信息，公告信息格式与旧版云文档格式相同。

前提条件

• 应用需要开启机器人能力。
• 调用当前接口的用户或者机器人必须在对应的群组内。
• 获取内部群信息时，调用当前接口的用户或者机器人必须与对应群组在同一租户下。

请求

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

路径参数

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

查询参数

名称	类型	必填	描述
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

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ content	string	群公告内容，以旧版云文档序列化数据结构展示，数据结构详情参考： - 编辑旧版文档内容 - 旧版文档数据结构参考
└ revision	string	文档当前版本号
└ create_time	string	文档生成的时间戳（秒）
└ update_time	string	文档更新的时间戳（秒）
└ owner_id_type	string	文档所有者的 ID 类型 - 如果所有者是用户，则类型与查询参数中的 user_id_type 相同，取值为open_id user_id union_id 其中之一，不同 ID 的说明参见 用户相关的 ID 概念。 - 如果所有者是机器人，为机器人应用的 app_id，详情参见 获取应用身份访问凭证。 可选值有： - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。 - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。 - open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。 - app_id: 飞书开放平台应用的唯一标识。在创建应用时，由系统自动生成，用户不能自行修改。
└ owner_id	string	文档所有者 ID，ID 类型与 owner_id_type 取值一致。
└ modifier_id_type	string	文档最新修改者 ID 类型。 - 如果修改者是用户，则类型与查询参数中的 user_id_type 相同，取值为open_id user_id union_id 其中之一，不同 ID 的说明参见 用户相关的 ID 概念。 - 如果修改者是机器人，为机器人应用的 app_id，详情参见 获取应用身份访问凭证。 可选值有： - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。 - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。 - open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。 - app_id: 飞书开放平台应用的唯一标识。在创建应用时，由系统自动生成，用户不能自行修改。
└ modifier_id	string	文档最新修改者 ID，ID 类型与 modifier_id_type 取值一致。

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "content": "xxx",
        "revision": "12",
        "create_time": "1609296809",
        "update_time": "1609296809",
        "owner_id_type": "open_id",
        "owner_id": "ou_7d8a6e6df7621556ce0d21922b676706ccs",
        "modifier_id_type": "open_id",
        "modifier_id": "ou_7d8a6e6df7621556ce0d21922b676706ccs"
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	232001	Your request contains an invalid request parameter.	参数错误，参考接口文档提供的参数描述，检查输入参数是否有误。
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.	操作者不在群组中。你需要将当前调用 API 的应用或用户加入待操作的群组后重试。
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 类型的新版本群公告，请参考”获取新版本群公告信息”接口。

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