tt.getUnionGroupInfo
基础库 3.51.0 开始支持本方法,这是一个异步方法。
获取公会绑定群信息
前提条件 | 需要提前调用 tt.login({force: true}) 保证用户已登录宿主 |
业务背景 | 无 |
使用限制 | 目前仅支持抖音,抖音极速版,可以使用 tt.getSystemInfoSync 判断宿主 |
注意事项 | IDE 上该接口返回模拟结果,请使用真机预览调试 |
相关教程 |
语法
tt.getUnionGroupInfo(options)
参数说明
options 为 object 类型,属性如下:
属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
---|---|---|---|---|---|
unionId | string | 是 | 查询绑定群信息的公会 ID,格式限制为字母数字下划线,长度不超过 30 | 3.51.0 | |
success | function | 否 | 接口调用成功的回调函数 | 3.51.0 | |
fail | function | 否 | 接口调用失败的回调函数 | 3.51.0 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | 3.51.0 |
回调成功
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
errMsg | string | "getUnionGroupInfo:ok" | 3.51.0 |
bindStatus | boolean | 目前公会的绑定状态,true 则 公会已绑定,false 则公会未绑定 | 3.51.0 |
回调失败
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
errMsg | string | "getUnionGroupInfo:fail" + 详细错误信息 | 3.51.0 |
错误码
errorCode | errMsg | errorType | 说明 | 最低支持版本 |
---|---|---|---|---|
135801 | unknown error | F | 小游戏框架内部错误,有需要请创建工单咨询 | 3.51.0 |
135802 | server error | F | 小游戏框架内部错误,有需要请创建工单咨询 | 3.51.0 |
999985 | network unavailable | U | 网络请求失败 | 3.51.0 |
999986 | invoke too frequently | D | 接口调用太过频繁 | 3.51.0 |
999987 | The feature is not supported in app | D | 当前应用不支持该能力 | 3.51.0 |
999988 | The feature is not available in current operating system | D | 当前系统不支持该能力 | 3.51.0 |
999996 | not login | D | 用户未登录 | 3.51.0 |
999999 | invalid param | D | 参数错误 | 3.51.0 |
代码示例
tt.getUnionGroupInfo({ unionId: 'testUnionId', success(res) { console.log('tt.getUnionGroupInfo success', res); }, fail(res) { console.log('tt.getUnionGroupInfo failed', res); } });