获取群公告信息

GET

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

自建应用商店应用

获取会话中的群公告信息，公告信息格式与云文档格式相同。

注意事项：

应用需要开启机器人能力

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

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

错误码

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.	操作者需要在群组中。
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 GET 'https://open.feishu.cn/open-apis/im/v1/chats/oc_5ad11d72b830411d72b836c20/announcement' \
--header 'Authorization;'

响应示例

{
  "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"
  }
}

请求参数

Path 参数

chat_id

必需

待获取公告的群 ID

示例值： "oc_5ad11d72b830411d72b836c20"

示例值:

oc_5ad11d72b830411d72b836c20

Query 参数

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，字段权限要求：获取用户 user ID

示例值:

open_id

Header 参数

Authorization

string

必需

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

默认值:

Bearer {{access_token}}

返回响应

🟢200200 Success

application/json

Body

code

integer

必需

错误码，非 0 表示失败

msg

string

错误描述

必需

data

object

必需

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：以 user_id 来识别用户 union_id：以 union_id 来识别用户 open_id：以 open_id 来识别用户 app_id：以 app_id 来识别机器人应用

owner_id

string

必需

文档所有者 ID，ID 值与owner_id_type 中的ID类型对应

modifier_id_type

string

必需

文档最新修改者 id 类型如果修改者是用户，则与查询参数中的user_id_type 相同；取值为open_id user_id union_id 其中之一，不同 ID 的说明参见用户相关的 ID 概念如果修改者是机器人，为机器人应用的 app_id，详情参见获取应用身份访问凭证可选值有： user_id：以 user_id 来识别用户 union_id：以 union_id 来识别用户 open_id：以 open_id 来识别用户 app_id：以 app_id 来识别应用

modifier_id

string

必需

文档最新修改者 ID，ID 值与modifier_id_type 中的ID类型对应

修改于 2023-01-13 02:29:19

更新群公告信息

添加会话标签页

获取群公告信息

错误码#

请求参数

返回响应

错误码