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

    收藏
    我的收藏

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

    加入指定公会绑定的公开群

    前提条件

    需要提前调用 tt.login({force: true}) 保证用户已登录宿主

    业务背景
    使用限制
    • 目前仅支持抖音,抖音极速版,可以使用 tt.getSystemInfoSync 判断宿主
    • 该 API 必须要由用户点击触发,也就是只能在 tt.onTouchEnd 的回调里面同步调用该 API
    注意事项
    • IDE 上该接口返回模拟结果,请使用真机预览调试
    • 目前 success 回调代表拉起加群成功,是否加群由玩家决定,游戏无法感知
    相关教程

    语法

    tt.joinUnionGroup(options)

    参数说明

    options 为 object 类型,属性如下:

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

    查询绑定群信息的公会 ID,格式限制为字母数字下划线,长度不超过 30

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

    回调成功

    object 类型,属性如下:

    属性名类型说明最低支持版本
    errMsgstring
    "joinUnionGroup:ok"
    3.51.0

    回调失败

    object 类型,属性如下:

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

    错误码

    errorCodeerrMsgerrorType说明最低支持版本
    136101unknown errorF
    小游戏框架内部错误,有需要请创建工单咨询
    3.51.0
    136102server errorF
    小游戏框架内部错误,有需要请创建工单咨询
    3.51.0
    136103union is not bound to a groupD

    公会未绑定任何公开群

    3.51.0
    136104open page failF
    小游戏框架内部错误,有需要请创建工单咨询
    3.51.0
    999985network unavailableU

    网络请求失败

    3.51.0
    999986invoke too frequentlyD

    接口调用太过频繁

    3.51.0
    999987The feature is not supported in appD

    当前应用不支持该能力

    3.51.0
    999988The feature is not available in current operating systemD

    当前系统不支持该能力

    3.51.0
    999996not loginD

    用户未登录

    3.51.0
    999999invalid paramD

    参数错误

    3.51.0
    999976must be invoked by user tap gestureD

    必须由用户点击触发

    3.51.0

    代码示例

    开发者工具中预览

    tt.joinUnionGroup({ unionId: 'testUnionId', success(res) { console.log('tt.joinUnionGroup success', res); }, fail(res) { console.log('tt.joinUnionGroup failed', res); } });