圈组

获取已加入的超大群信息

更新时间: 2025/06/30 11:31:58

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

API 使用限制

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

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

URL

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

请求参数

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

返回参数

参数 类型 说明
code Integer 状态码,请求成功则返回 200。
count Integer 该用户已加入的超大群的数量。
- tinfos String 该用户已加入的超大群的详细信息,JSONArray 格式。
tid Long 超大群 ID。
tname String 超大群名称。
creator String 群主,创建者。
tlevel Integer 超大群级别,群最大人数。
size Integer 超大群大小,即当前群人数。
intro String 超大群介绍。
announcement String 超大群公告。
clientCustom String 第三方客户端自定义字段。
serverCustom String 第三方服务器扩展字段。
icon String 超大群头像。
muteType Integer 群禁言类型。0:取消全员禁言,1:全员禁言(不包括群主和管理员);3:全员禁言。
joinmode Integer 申请入群的验证方式。0:无需验证,直接入群;1:需要群主或管理员验证通过才能入群;2:不允许任何人申请入群。
beinvitemode Integer 邀请入群的验证方式。0:需要被邀请人同意才能入群;1:不需要被邀请人同意,直接入群。
invitemode Integer 邀请入群的权限,即谁可以邀请他人入群。0:群主和管理员;1:所有人。
uptinfomode Integer 修改群信息权限。0:群主和管理员;1:所有人。
upcustommode Integer 修改群自定义属性的权限。0:群主和管理员;1:所有人。
createtime Long 创建时间。
updatetime Long 更新时间。

示例

请求示例(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.yunxinapi.com/nimserver/superteam/joinTeams.action'

请求成功返回示例

JSON"Content-Type": "application/json; charset=utf-8"
{
    "code":200,
    "count":2,
    "tinfos":[ 
     {
        "tid": 111,  
        "tname": "tname",  
        "creator": "user123", 
        "tlevel": 500, 
        "size": 120,  
        "intro": "intro", 
        "announcement": "announcement", 
        "clientCustom": "clientCustom", 
        "serverCustom": "serverCustom", 
        "icon": "icon", 
        "muteType": 0,  
        "joinmode": 0,  
        "beinvitemode": 0,  
        "invitemode": 0,  
        "uptinfomode": 0, 
        "upcustommode": 0, 
        "createtime": 0, 
        "updatetime": 0, 
      },
    {}  // 其他超大群信息  
    ]
}

请求失败返回示例

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

状态码

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

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