API 参考
圈组

获取群组详细信息

更新时间: 2024/07/17 17:57:35

查询指定群的详细信息(群信息+成员详细信息)。

API 使用限制

单个应用中 1 秒内所有的高级群操作 API 合计最多可调用 100 次,超过后限制调用,会返回 416 错误码。

除发送群消息 API 外,其他所有高级群 API 都属于高级群操作 API。

URL

POST https://api.netease.im/nimserver/team/queryDetail.action  HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8

请求参数

  • POST 请求中 Headers 的设置请参考API 调用方式
  • POST 请求中 Body 的设置如下:
参数类型必填说明
tidLong服务器产生,群唯一标识,创建群时会返回,最大长度 64 位长整型

返回参数

参数 类型 说明
code Integer 状态码
tinfo String 群组的详细信息

tinfo 中的参数说明

参数类型说明
iconString群头像
announcementString群公告
uptinfomodeInteger客户端修改群信息权限
0,群主和管理员(默认);1,所有人
introString群介绍
maxusersInteger群成员最大数量
upcustommodeInteger修客户端改群自定义属性的权限
0,群主和管理员(默认);1,所有人
tnameString群名称
beinvitemodeInteger邀请入群的验证方式,即邀请入群后,是否需要被邀请人的同意
0,需要同意(默认);1,不需要同意
joinmodeInteger申请入群的验证方式
0,不用验证;1,需要群主或管理员的验证;2,不允许任何人加入
tidLong群 ID
invitemodeInteger邀请入群的权限,即谁可以邀请他人入群
0,群主和管理员(默认);1,所有人
muteBoolean是否全员禁言
muteTypeInteger禁言类型
0,解除禁言;1,禁言普通成员;3,禁言整个群(包括群主)
customString自定义高级群扩展属性
clientCustomString客户端自定义字段
createtimeLong创建时间
updatetimeLong更新时间
isNotifyCloseOnline Boolean群通知消息是否关闭在线发送(开启该功能才会有该字段)
isNotifyClosePersistentBoolean群通知消息是否关闭持久化存储(开启该功能才会有该字段)
ownerString群主信息,包含群昵称(nick)、用户 ID(accid)、是否被禁言(mute)等信息
adminsString管理员信息,JSON,包含群昵称(nick)、用户 ID(accid)、是否被禁言(mute)等信息
membersString群成员信息,JSON,包含群昵称(nick)、用户 ID(accid)、是否被禁言(mute)等信息

示例

请求示例(curl)

curlcurl -X POST -H "AppKey: go9dnk**kglw0803mgq3" -H "Nonce: 4tggge**t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535' 'https://api.netease.im/nimserver/team/queryDetail.action'

请求成功返回示例

json"Content-Type": "application/json; charset=utf-8"
{
    "code": 200,  
    //以下参数可参照创建群接口
    "tinfo": {
        "icon": null,   
        "announcement": null,  
        "uptinfomode": 0,  
        "maxusers": 1000, 
        "intro": null,  
        "upcustommode": 0, 
        "tname": "test",  
        "beinvitemode": 1,  
        "joinmode": 0, 
        "tid": 17889, 
        "invitemode": 1, 
        "mute": false, 
        "muteType": 0,  
        "custom":""   
        "clientCustom":""  
        "createtime": 1506652312445,   
        "updatetime": 1521082125400, 
        "isNotifyCloseOnline":"true", 
        "isNotifyClosePersistent":"true",
        "owner": {
            "createtime": 1506652312445,
            "updatetime": 1506655709409,
            "nick": "nick1", 
            "accid": "user1",  
            "mute": false,   
            "custom": null  
        },
        "admins": [
            {
                "createtime": 1506652312445,
                "updatetime": 1506671333528,
                "nick": "usernick2",
                "accid": "user2",
                "mute": false,
                "custom": ""
            }
        ],
        "members": [
            {
                "createtime": 1506652312445,
                "updatetime": 1506671333528,
                "nick": "usernick3",
                "accid": "user3",
                "mute": false,
                "custom": null
            },
            {
                "createtime": 1506652312445,
                "updatetime": 1506652312445,
                "nick": "usernick4",
                "accid": "user4",
                "mute": false,
                "custom": null
            }
        ]
    }
}

请求失败返回示例

"Content-Type": "application/json; charset=utf-8"
{
"code": 414,  // 参数错误
"desc": "xxxx  is empty" 
}

状态码

该接口在 HTTPS Body 中返回请求的状态码,以下仅列出与接口业务相关的状态码。完整状态码请参见状态码

状态码 说明 处理建议
200 请求成功 -
403 禁止操作 -
414 参数错误 根据提示信息,检查传入参数的格式和限制条件
416 调用频率超出限制 降低访问频率
500 服务出错 -
此文档是否对你有帮助?
有帮助
去反馈
  • API 使用限制
  • URL
  • 请求参数
  • 返回参数
  • 示例
  • 请求示例(curl)
  • 请求成功返回示例
  • 请求失败返回示例
  • 状态码