API 参考
圈组

获取已加入的超大群信息

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

可根据用户的账号(accid)查询该用户所加入的超大群的信息,包括群名称、群主、群用户上限等。

API 使用限制

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

  • 除超大群消息相关 API 外,其他所有超大群 API 都属于超大群操作 API。
  • 超大群消息相关 API 包括:发送超大群消息,发送超大群自定义系统通知,撤回超大群消息,根据用户 ID/消息 ID 查询超大群历史消息。

URL

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

请求参数

  • POST 请求中 Headers 的设置请参考接口概述
  • POST 请求中 Body 的设置如下:
参数类型必填说明
accidString用户帐号,最大长度 32 位字符

返回参数

参数类型说明
codeInteger状态码,请求成功则返回 200
countInteger该用户已加入的超大群的数量
tinfosString该用户已加入的超大群的详细信息,JSONArray 格式

tinfos 中的参数说明

参数 类型 说明
owner String 群主账号,accid
tname String 超大群名称
maxusers Integer 超大群人数上限
tid Long 超大群 ID
size Integer 当前超大群有效成员数量
custom String 自定义信息

示例

请求示例(curl)

curlcurl -X POST -H "AppKey: go9dnk49bk***3mgq3" -H "Nonce: 4tgg***t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d '=accid=zhangsan' 'https://api.netease.im/nimserver/superteam/joinTeams.action'

请求成功返回示例

json"Content-Type": "application/json; charset=utf-8"
{
    "code":200,
    "count":2,
    "tinfos":[    //群的具体信息 
       {"owner":"t2",  
        "tname":"test1", 
        "maxusers":50, 
        "tid":3620,   
        "size":3,  
        "custom":""    },
       {"owner":"t1","tname":"test2","maxusers":50,"tid":3622,"size":4, "custom":""}
    ]
}

请求失败返回示例

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

状态码

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

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