获取群公告基本信息

获取指定群组中的群公告基本信息。

前提条件

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

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/docx/v1/chats/:chat_id/announcement
HTTP Method	GET
接口频率限制	20 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	im:chat.announcement:read 查看群公告信息
字段权限要求	> 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	\-	-
└ revision_id	int	群公告当前版本号
└ create_time	int	群公告生成的时间戳（秒）
└ update_time	int	群公告更新的时间戳（秒）
└ owner_id	string	群公告所有者 ID，ID 值与 owner_id_type 中的ID类型对应
└ owner_id_type	string	群公告所有者的 ID 类型 可选值有： - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。 - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。 - open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。
└ modifier_id	string	群公告最新修改者 ID，ID 值与 modifier_id_type 中的ID类型对应
└ modifier_id_type	string	群公告最新修改者 ID 类型 可选值有： - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。 - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。 - open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。
└ announcement_type	string	群公告类型 可选值有： - docx: 新版本群公告 - doc: 旧版本群公告
└ create_time_v2	string	群公告生成的时间戳（秒）（该字段暂未提供使用）
└ update_time_v2	string	群公告更新的时间戳（秒）（该字段暂未提供使用）

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "revision_id": 1,
        "create_time": 1609296809,
        "update_time": 1609296809,
        "owner_id": "ou_7d8a6e6df7621556ce0d21922b676706ccs",
        "owner_id_type": "user_id",
        "modifier_id": "ou_7d8a6e6df7621556ce0d21922b676706ccs",
        "modifier_id_type": "user_id",
        "announcement_type": "docx",
        "create_time_v2": "1609296809",
        "update_time_v2": "1609296809"
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	1770001	invalid param	参数错误，参考接口文档提供的参数描述，检查输入参数是否有误。
404	1770002	not found	群公告不存在，请检查传入的 chat_id 是否正确。
400	1772001	Chat announcement can NOT be found in chat information.	群公告信息异常。请重试，若仍无法解决请咨询技术支持
400	1772002	Operator and chat can NOT be in different tenants.	操作内部群时，操作者和被操作的群组必须在同一租户下。请检查当前调用身份是否和群组属于同一租户。
400	1772003	Operator can NOT be out of the chat.	操作者不在群组中。你需要将当前调用 API 的应用或用户加入待操作的群组后重试。
400	1772004	The operator or invited bots does NOT have the authority to manage external chats without the scope.	当前被操作的群为外部群，暂不支持操作外部群。
400	1772025	Bot ability is not activated.	应用未启用机器人能力。你需要登录开发者后台，在应用详情页的 应用能力 > 添加应用能力 页面内，添加 机器人 能力，并发布应用使配置生效。具体操作参见机器人能力。
400	1772006	announcement type is not supported	除「获取群公告基本信息」接口，其它新版群公告接口均无法操作 doc 类型的群公告，如需操作 doc 类型群公告请参考「旧版群公告」接口。
400	1772034	The app is unavailable or inactivated by the tenant.	应用在本租户下未安装或未启用。需要先安装应用，再使用应用调用接口。
403	1770032	forbidden	操作者没有群公告的阅读或编辑权限。你需要为当前调用 API 的应用或用户添加文档阅读或编辑权限后重试。
500	1771001	server internal error	服务器内部错误。请重试，若仍无法解决请咨询技术支持
500	1771002	gateway server internal error	服务器内部错误。请重试，若仍无法解决请咨询技术支持
500	1771003	gateway marshal error	服务序列化解析错误。请重试，若仍无法解决请咨询技术支持
500	1771004	gateway unmarshal error	服务反序列化解析错误。请重试，若仍无法解决请咨询技术支持
503	1771005	system under maintenance	系统服务正在维护中

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