获取群信息

获取群名称、群描述、群头像、群主 ID 等群基本信息。

注意事项：

机器人或授权用户必须在群里（否则只会返回群名称、群头像等基本信息）

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

错误码

HTTP状态码	错误码	描述	排查建议
400	232004	Such an app does NOT exist.	作为操作者的 app_id 不存在，请联系技术支持。
400	232006	Your request specifies a chat_id which is invalid.	无效的 chat_id，请检查chat_id是否正确。
400	232010	Operator and chat can NOT be in different tenants.	操作者和被操作的群组应该在同一租户下。
400	232011	Operator can NOT be out of the chat.	操作者需要在群组中。
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.	应用在本租户下未安装或未启用。

curl --location --request GET 'https://open.feishu.cn/open-apis/im/v1/chats/oc_a0553eda9014c201e6969b478895c230' \ --header 'Authorization;' \ --header 'Content-Type: text/plain' \ --data-raw 'curl --location --request GET '\''https://open.feishu.cn/open-apis/im/v1/chats/oc_84983ff6516d731e5b5f68d4ea2e1da5?user_id_type=open_id'\'' \ --header '\''Authorization: Bearer t-f6a6b2a3a0ddee933a770f7d8678f8f7553bb2a8'\'''

{ "code": 0, "msg": "success", "data": { "avatar": "https://p3-lark-file.byteimg.com/img/lark-avatar-staging/default-avatar_44ae0ca3-e140-494b-956f-78091e348435~100x100.jpg", "name": "测试群名称", "description": "测试群描述", "i18n_names": { "zh_cn": "群聊", "en_us": "group chat", "ja_jp": "グループチャット" }, "add_member_permission": "all_members", "share_card_permission": "allowed", "at_all_permission": "all_members", "edit_permission": "all_members", "owner_id_type": "user_id", "owner_id": "4d7a3c6g", "chat_mode": "group", "chat_type": "private", "chat_tag": "inner", "join_message_visibility": "only_owner", "leave_message_visibility": "only_owner", "membership_approval": "no_approval_required", "moderation_permission": "all_members", "external": false, "tenant_key": "736588c9260f175e" } }

请求参数

Path 参数

chat_id

string

必需

群 ID，详情参见群ID 说明 示例值："oc_a0553eda9014c201e6969b478895c230"

示例值:

oc_a0553eda9014c201e6969b478895c230

Header 参数

Authorization

string

必需

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

默认值:

Bearer {{access_token}}

Body 参数text/plain

示例

返回响应

🟢200200Success

application/json

Body

code

integer

必需

错误码，非 0 表示失败

msg

string

错误描述

必需

data

object

必需

avatar

string

群头像 URL

必需

name

string

群名称

必需

description

string

群描述

必需

i18n_names

object

群国际化名称

必需

add_member_permission

string

必需

群成员添加权限(all_members/only_owner)

share_card_permission

string

必需

群分享权限(allowed/not_allowed)

at_all_permission

string

必需

at 所有人权限(all_members/only_owner)

edit_permission

string

必需

群编辑权限(all_members/only_owner)

owner_id_type

string

必需

群主 ID 的类型(open_id/user_id/union_id)，群主是机器人时，不返回该字段。

owner_id

string

必需

群主 ID，群主是机器人时，不返回该字段。

chat_mode

string

必需

群模式(group/topic/p2p)

chat_type

string

必需

群类型(private/public)

chat_tag

string

必需

优先级最高的一个群tag(inner/tenant/department/edu/meeting/customer_service)

join_message_visibility

string

必需

入群消息可见性(only_owner/all_members/not_anyone)

leave_message_visibility

string

必需

出群消息可见性(only_owner/all_members/not_anyone)

membership_approval

string

必需

加群审批(no_approval_required/approval_required)

moderation_permission

string

必需

发言权限(all_members/only_owner/moderator_list)

external

boolean

是否是外部群

必需

tenant_key

string

必需

tenant key

user_count

string

群成员人数

必需

bot_count

string

群机器人数

必需

错误码#

请求参数

返回响应

错误码