抖音开放平台Logo
开发者文档
“/”唤起搜索
控制台
  • JavaScript API
  • C# API
  • API 概览
  • 初始化
  • 基础
  • 调试工具
  • 界面
  • 渲染
  • 数据缓存
  • PlayerPrefs
  • 文件
  • 设备
  • 网络
  • 系统
  • 媒体
  • 支付
  • 广告
  • 位置
  • 开放能力
  • 账号
  • 侧边栏
  • 收藏
  • 群聊
  • 平台开放能力
  • 推荐流直出游戏能力
  • 社交互动能力
  • 游戏互推组件
  • 好友排行榜
  • 数据分析
  • 客服能力
  • 直播能力
  • 公会群能力
  • 群标签能力
  • 游戏分享
  • 邀请模块
  • 抖音云模块
  • 群聊
    收藏
    我的收藏

    TT.JoinGroup

    ​
    6.0.0 开始支持本方法,WebGL也支持该方法
    在平台创建群聊,获得 groupid 后,游戏内通过这个方法引导用户加入抖音群。
    前提条件
    使用本 API 前需要先在开发者平台创建群聊获取 groupid。具体可参考游戏群聊能力接入介绍
      1.前往开发者平台,「运营 - 运营能力 - 粉丝群能力 」,申请开通能力
      2.扫码绑定抖音号后,点击「新建群聊」以获得对应的群 ID
    业务背景
    无
    使用限制
    目前仅支持抖音及抖音极速版
    注意事项
    无
    相关教程

    语法

    public static void JoinGroup(data, action, sessionFrom, extraInfo)

    参数说明

    属性名
    类型
    默认值
    必填
    说明
    groupId
    string
    --
    是
    群 ID
    action
    Action<bool, string>
    null
    否
    bool = true设置成功,反则关注错误信息
    sessionFrom
    string
    null
    否
    会话来源
    extraInfo
    string
    null
    否
    附加信息

    代码示例

    private void Test() { TT.JoinGroup(groupId, (isSuccess, data) => { if (isSuccess) { Debug.Log($"Call JoinGroup success, {data}"); } else { Debug.Log($"Call JoinGroup fail, {data}"); } }); }
    ​

    TT.CheckGroupInfo

    6.0.0 开始支持本方法,WebGL也支持该方法
    查询用户通过小游戏平台创建的群的信息。
    如游戏开发者在平台创建了群聊 ABC,那么游戏侧可以基于游戏开发者在这个游戏中的 openid,查询其在小游戏平台创建了哪些群,群的状态如何,做游戏内的加群逻辑优化。
    前提条件
    无
    业务背景
    无
    使用限制
    目前仅支持抖音,可以使用 getSystemInfoSync 判断宿主
    注意事项
    查询到的群列表只局限在通过游戏创建的群聊或开发者在平台创建的群聊,其他渠道创建的群聊不会返回
    相关教程
    无

    语法

    public static void CheckGroupInfo(openId, onCheckGroupInfoSuccessCallback, onCheckGroupInfoFailCallback, sessionFrom, extraInfo)

    参数说明

    属性名
    类型
    默认值
    必填
    说明
    openId
    string
    ​
    是
    建群用户的 openid
    onCheckGroupInfoSuccessCallback
    delegate void OnCheckGroupInfoSuccessCallback(ref List<GroupInfo> groupInfoList)
    ​
    是
    接口调用成功的回调函数
    ​
    onCheckGroupInfoFailCallback
    delegate void OnCheckGroupInfoFailCallback(string errMsg);
    ​
    是
    接口调用失败的回调函数
    bool = true设置成功,反则关注错误信息
    sessionFrom
    string
    null
    否
    会话来源
    extraInfo
    string
    null
    否
    附加信息

    代码示例

    private void Test() { TT.CheckGroupInfo(openId, (ref List<TTGroup.GroupInfo> list) => { Debug.Log($"Call CheckGroupInfo success, {list.ToJson()}"); }, errMsg => { Debug.Log($"Call CheckGroupInfo fail, {errMsg}"); }); }
    ​