查询群组信息
更新时间: 2025/08/21 17:27:49
该接口用于查询指定群组的详细信息,包括群组属性以及群成员信息。
调用频率
单个应用默认最高调用频率请参考 频控说明。
请求信息
请求 URL
GET https://{endpoint}/im/v2.1/teams/{team_id}
请求 URL 中的 {endpoint}
代表服务地址域名,您可以根据用户服务区域选择中国大陆和海外服务地址,并支持搭建高可用主备域名机制。详情请参考 调用方式 服务地址章节。
请求头参数
请求 Header 的参数说明请参考 请求 Header。
请求路径参数
参数名称 | 类型 | 是否必选 | 说明 |
---|---|---|---|
team_id |
Long | 是 | 需要查询的群组 ID,创建群组成功时,网易云信服务器会自动生成并返回。 |
请求查询参数
参数名称 | 类型 | 是否必选 | 说明 |
---|---|---|---|
team_type |
Integer | 是 | 需要查询的群组类型。1:高级群。2:超大群。 |
请求示例
bashGET https://open.yunxinapi.com/im/v2.1/teams/39801639638?team_type=1
响应信息
响应头参数
响应 Header 的参数说明请参考 响应 Header。
响应体参数
参数名称 | 类型 | 说明 | 是否必返回 |
---|---|---|---|
code |
Integer | 状态码,200 表示请求成功。 |
是 |
msg |
String | 提示信息。请求失败时返回错误信息,请求成功时返回 "success" 。 |
是 |
-
data |
Object | 返回的 JSON 数据对象,请求失败则返回空对象。 | 是 |
-
team_info |
Object | 查询到的群组信息。 | 是 |
team_id |
Long | 群组 ID,网易云信服务器返回。 | 是 |
team_type |
Integer | 群组类型。1:高级群。2:超大群。 | 是 |
owner_account_id |
String | 群主账号 ID。 | 是 |
member_count |
Integer | 返回群成员数量。 | 是 |
name |
String | 群组名称。 | 是 |
icon |
String | 群组头像的 URL 地址。 | 否 |
announcement |
String | 群组公告 | 否 |
intro |
String | 群组简介。 | 否 |
members_limit |
Integer | 群容量,最大人数。 | 是 |
server_extension |
String | 自定义群扩展字段,第三方可以跟据此属性自定义扩展自己的群属性,建议封装成 JSON 格式,{key:value} 。 |
否 |
customer_extension |
String | 客户自定义扩展字段,仅服务器 API 可以设置,SDK 仅负责透传,不解析内容。 | 否 |
create_time |
Long | 群组创建时间戳。 | 是 |
update_time |
Long | 群组更新时间戳。 | 是 |
-
configuration |
Object | 群组配置项。 | 是 |
join_mode |
Integer | 群组创建完成后,通过 SDK 侧操作申请入群的验证方式。 |
是 |
agree_mode |
Integer | 群组创建完成后,邀请入群时是否需要被邀请人的同意。 |
是 |
invite_mode |
Integer | 邀请权限,即谁可以邀请他人入群。 |
是 |
update_team_info_mode |
Integer | 客户端修改群组信息的权限,即谁可以修改群组信息。 |
是 |
update_extension_mode |
Integer | 客户端修改群自定义扩展信息(server_extension&extension)权限,即谁可以修改群自定义扩展信息。 |
是 |
chat_banned_mode |
Integer | 群组禁言状态。 |
否 |
响应体示例
JSON{
"code": 200,
"msg": "success",
"data": {
"team_info": {
"customer_extension": "server_extension-v2",
"update_time": 1752548954030,
"create_time": 1752548954030,
"configuration": {
"join_mode": 0,
"invite_mode": 1,
"agree_mode": 1,
"update_extension_mode": 1,
"update_team_info_mode": 1,
"chat_banned_mode": 0
},
"intro": "intro",
"name": "name1752548953661",
"icon": "icon",
"owner_account_id": "test",
"members_limit": 200,
"team_id": 44055499232,
"team_type": 1,
"member_count": 5,
"announcement": "announcement"
}
}
}
错误码
本文仅列举部分业务接口错误码,完整列表请参考客户端 API 错误码。
错误码 | 错误码描述 | 错误信息示例 |
---|---|---|
200 | 请求成功 | success |
414 | 参数错误 | parameter error |
416 | 频控超出限制 | rate limit exceeded |
108311 | 超大群服务未开通 | super team service disabled |
108404 | 群组不存在 | team not exist |
108302 | 非高级群 | not advanced team |
500 | 服务端内部错误 | internal server error |
503 | 服务器繁忙 | server busy |
此文档是否对你有帮助?