tt.joinGroup
收藏
我的收藏基础库 2.70.0 开始支持本方法,这是一个异步方法。
在平台创建群聊,获得 groupid 后,游戏内通过这个方法引导用户加入抖音群
前提条件 | 使用本 API 前需要先在开发者平台创建群聊获取 groupid。具体可参考游戏群聊能力接入介绍
|
业务背景 | 无 |
使用限制 |
|
注意事项 | 无 |
相关教程 |
语法
tt.joinGroup(options)
参数说明
options 为 object 类型,属性如下:
属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
---|---|---|---|---|---|
extraInfo | string | 否 | 附加信息 | 2.70.0 | |
groupid | string | 是 | 群 ID | 2.70.0 | |
success | function | 否 | 接口调用成功的回调函数 | 2.70.0 | |
fail | function | 否 | 接口调用失败的回调函数 | 2.70.0 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | 2.70.0 |
回调成功
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
data | object | 加群信息 | 2.70.0 |
errMsg | string | "joinGroup:ok" | 2.70.0 |
data 类型说明
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
openid | string | 用户的openid | 2.70.0 |
groupid | string | 群 ID | 2.70.0 |
回调失败
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
errMsg | string | "joinGroup:fail" + 详细错误信息 | 2.70.0 |
代码示例
tt.joinGroup({ groupid: "998877", //加入的群id,可在平台创建群聊后获得 sessionFrom: "sessionFrom", extraInfo: "extraInfo", success(res) { console.log(res); }, fail(res) { console.log(res); } });
点击纠错