抖音开放平台Logo
开发者文档
控制台
  • API 概览
  • 开放能力
  • 登录
  • 社交转发裂变
  • 用户信息及授权
  • 小游戏收藏
  • 群聊
  • tt.joinGroup
  • tt.checkGroupInfo
  • 关注
  • 游戏互推组件
  • 添加到桌面
  • 游戏排行榜
  • 数据分析
  • 视频拍摄器
  • 订阅消息
  • 关系链
  • 客服能力
  • 侧边栏能力
  • 推荐流直出游戏能力
  • 基础
  • 渲染
  • 设备
  • 文件
  • 位置
  • 媒体
  • 网络
  • 游戏转发分享
  • 实时语音
  • 数据缓存
  • 系统
  • 广告
  • 界面
  • 支付
  • Worker
  • tt.checkGroupInfo

    收藏
    我的收藏

    基础库 2.70.0 开始支持本方法,这是一个异步方法。

    查询用户通过小游戏平台创建的群的信息 如游戏开发者在平台创建了群聊 ABC,那么游戏侧可以基于游戏开发者在这个游戏中的 openid,查询其在小游戏平台创建了哪些群,群的状态如何,做游戏内的加群逻辑优化

    前提条件
    业务背景
    使用限制

    目前仅支持抖音,可以使用 getSystemInfoSync 判断宿主

    注意事项

    查询到的群列表只局限在通过游戏创建的群聊或开发者在平台创建的群聊,其他渠道创建的群聊不会返回

    相关教程

    语法

    tt.checkGroupInfo(options)

    参数说明

    options 为 object 类型,属性如下:

    属性名类型默认值必填说明最低支持版本
    extraInfostring

    预留字段

    2.70.0
    openidstring

    建群用户的 openid。通过 tt.login 接口获取到登录凭证后,开发者可以通过服务器发送请求的方式获取 openid。详情参考 code2Session

    2.70.0
    sessionFromstring

    预留字段

    2.70.0
    successfunction
    接口调用成功的回调函数
    2.70.0
    failfunction
    接口调用失败的回调函数
    2.70.0
    completefunction
    接口调用结束的回调函数(调用成功、失败都会执行)
    2.70.0

    回调成功

    object 类型,属性如下:

    属性名类型说明最低支持版本
    dataobject

    查询返回的数据

    2.70.0
    errMsgstring
    "checkGroupInfo:ok"
    2.70.0

    data 类型说明

    object 类型,属性如下:

    属性名类型说明最低支持版本
    groupInfoListArray<object>

    群聊列表信息

    2.70.0

    groupInfoList 类型说明

    object 类型,属性如下:

    属性名类型说明最低支持版本
    group_idstring

    群 ID

    2.70.0
    group_namestring

    群名

    2.70.0
    exist_numnumber

    群现有人数

    2.70.0
    max_numnumber

    群最大支持进入人数

    2.70.0
    descriptionnumber

    群描述

    2.70.0
    entry_limitArray<string>

    群门槛,如“无要求”、“万粉”等

    2.70.0
    statusstring

    群状态,正常: Normal, 封禁: Ban, 已满: Full

    2.70.0
    tagsArray<string>

    群标签,如活跃群,群主近期发言

    2.70.0
    avatar_uristring

    群头像

    2.70.0

    回调失败

    object 类型,属性如下:

    属性名类型说明最低支持版本
    errMsgstring
    "checkGroupInfo:fail" + 详细错误信息
    2.70.0

    错误码

    errorCodeerrMsgerrorType说明最低支持版本
    110501user not authorized to appU
    2.70.0
    110502service unavailableF
    小游戏框架内部错误,有需要请创建工单咨询
    2.70.0
    999991internal errorF
    小游戏框架内部错误,有需要请创建工单咨询
    2.70.0
    999993internal errorF
    小游戏框架内部错误,有需要请创建工单咨询
    2.70.0
    999999invalid paramD
    参数错误
    2.70.0
    999987feature is not supported in appD
    2.70.0
    999999openid is nil.D
    2.70.0
    999997user login failedU
    2.70.0
    110503The user has not completed real-name authentication in appU
    2.70.0
    999986auth alert view is showing..D
    2.70.0

    代码示例

    tt.checkGroupInfo({ openid: "openid", success(res) { console.log(res); }, fail(res) { console.log(res); }, });