抖音开放平台Logo
开发者文档
控制台

tt.joinGroup

收藏
我的收藏

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

在平台创建群聊,获得 groupid 后,游戏内通过这个方法引导用户加入抖音群

前提条件

使用本 API 前需要先在开发者平台创建群聊获取 groupid。具体可参考游戏群聊能力接入介绍

  1. 前往开发者平台,「运营 - 运营能力 - 粉丝群能力 」,申请开通能力
  2. 扫码绑定抖音号后,点击「新建群聊」以获得对应的群 ID
业务背景
使用限制
  • 目前仅支持抖音及抖音极速版
  • 该 API 必须要由用户点击触发,只能在 tt.onTouchEnd 的回调里面同步调用该 API
注意事项
相关教程

语法

tt.joinGroup(options)

参数说明

options 为 object 类型,属性如下:

属性名类型默认值必填说明最低支持版本
extraInfostring
附加信息
2.70.0
groupidstring
群 ID
2.70.0
successfunction
接口调用成功的回调函数
2.70.0
failfunction
接口调用失败的回调函数
2.70.0
completefunction
接口调用结束的回调函数(调用成功、失败都会执行)
2.70.0

回调成功

object 类型,属性如下:

属性名类型说明最低支持版本
dataobject
加群信息
2.70.0
errMsgstring
"joinGroup:ok"
2.70.0

data 类型说明

object 类型,属性如下:

属性名类型说明最低支持版本
openidstring
用户的openid
2.70.0
groupidstring
群 ID
2.70.0

回调失败

object 类型,属性如下:

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

代码示例

tt.joinGroup({ groupid: "998877", //加入的群id,可在平台创建群聊后获得 sessionFrom: "sessionFrom", extraInfo: "extraInfo", success(res) { console.log(res); }, fail(res) { console.log(res); } });