在线调试

批量查询群组信息列表

更新时间: 2025/08/21 17:27:49

该接口用于批量查询指定群组的详细信息列表。

调用频率

单个应用默认最高调用频率请参考 频控说明

请求信息

请求 URL

GET https://{endpoint}/im/v2.1/teams

请求 URL 中的 {endpoint} 代表服务地址域名,您可以根据用户服务区域选择中国大陆和海外服务地址,并支持搭建高可用主备域名机制。详情请参考 调用方式 服务地址章节。

请求头参数

请求 Header 的参数说明请参考 请求 Header

请求查询参数

参数名称 类型 是否必选 说明
team_ids Array of longs 需要查询的群组 ID 列表。高级群一次最多查询 30 个群组,超大群一次最多查询 20 个群组。
team_type Integer 群组类型。
1:高级群。
2:超大群。

响应信息

响应头参数

响应 Header 的参数说明请参考 响应 Header

响应体参数

参数名称 类型 说明 是否必返回
code Integer 状态码,200 表示请求成功。
msg String 提示信息。请求失败时返回错误信息,请求成功时返回 "success"。
- data Object 返回的 JSON 数据对象,请求失败则返回空对象。
invalid_tids Array of longs 查询失败的群 ID 列表。
- team_info_list Array of objects 查询成功的群组信息列表。
team_id Long 群组 ID,网易云信服务器返回。
team_type Integer 群组类型。
1:高级群。
2:超大群。
owner_account_id String 群主的账号 ID。
member_count Number 返回群成员数量。
name String 群组名称。
icon String 群组头像的 URL 地址。
announcement String 群组公告
intro String 群组简介。
members_limit Integer 群组成员数上限(包含群主)。
server_extension String 服务端自定义群扩展字段,第三方可以跟据此属性自定义扩展自己的群属性,建议封装成 JSON 格式,{key:value}。
customer_extension String 客户端自定义扩展字段。
create_time Long 群组创建时间戳。
update_time Long 群组更新时间戳。
- configuration Object 群组配置项。
join_mode Integer 群组创建完成后,通过 SDK 侧操作申请入群的验证方式。
  • 0:无需验证,直接入群。
  • 1:需要群主或管理员验证通过才能入群。
  • 2:不允许任何人申请入群。
  • agree_mode Integer 群组创建完成后,邀请入群时是否需要被邀请人的同意。
  • 0:需要被邀请人同意才能入群。
  • 1:不需要被邀请人同意,直接入群。
  • invite_mode Integer 邀请权限,即谁可以邀请他人入群。
  • 0:群主和管理员。
  • 1:所有人。
  • update_team_info_mode Integer 客户端修改群组信息的权限,即谁可以修改群组信息。
  • 0:群主和管理员。
  • 1:所有人。
  • update_extension_mode Integer 客户端修改群自定义扩展信息(server_extension&extension)权限,即谁可以修改群自定义扩展信息。
  • 0:群主和管理员。
  • 1:所有人。
  • chat_banned_mode Integer 群组禁言状态。
  • 0:取消全员禁言。
  • 1:全员禁言(不包括群主和管理员)。
  • 3:全员禁言。
  • 响应体示例

    JSON{
      "code": 200,
      "msg": "success",
      "data": {
        "invalid_tids": [],
        "team_info_list": [
          {
            "customer_extension": "updatecustomer_extension-v2.1",
            "create_time": 1753855694939,
            "team_type": 1,
            "configuration": {
              "join_mode": 0,
              "invite_mode": 0,
              "agree_mode": 1,
              "update_extension_mode": 0,
              "update_team_info_mode": 0,
              "chat_banned_mode": 0
            },
            "icon": "updateicon",
            "owner_account_id": "yytest96",
            "team_id": 2366935480,
            "server_extension": "updateserver_extension-v2.1",
            "update_time": 1753855695177,
            "intro": "yytest96高级team描述",
            "name": "yytest96高级team",
            "members_limit": 200,
            "member_count": 3,
            "announcement": "yytest96高级team公告"
          }
        ]
      }
    }
    

    错误码

    本文仅列举部分业务接口错误码,完整列表请参考客户端 API 错误码

    错误码 错误码描述 错误信息示例
    200 请求成功 success
    414 参数错误 parameter error
    416 频控超出限制 rate limit exceeded
    108311 超大群服务未开通 super team service disabled
    500 服务端内部错误 internal server error
    503 服务器繁忙 server busy
    此文档是否对你有帮助?
    有帮助
    去反馈
    • 调用频率
    • 请求信息
    • 请求 URL
    • 请求头参数
    • 请求查询参数
    • 响应信息
    • 响应头参数
    • 响应体参数
    • 响应体示例
    • 错误码