tt.openWebcastRoom
基础库 2.53.0 开始支持本方法,低版本需做兼容处理,这是一个异步方法。
提供从小程序跳转到直播间的能力。仅支持抖音和抖音 Lite APP。
语法
tt.openWebcastRoom(options)
参数说明
options 为 object 类型,属性如下:
属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
---|---|---|---|---|---|
awemeId | string | -- | 是 | 用户的抖音号 | 2.53.0 |
success | function | -- | 否 | 接口调用成功的回调函数 | 2.53.0 |
fail | function | -- | 否 | 接口调用失败的回调函数 | 2.53.0 |
complete | function | -- | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | 2.53.0 |
回调成功
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
errMsg | string | 回调信息 | 2.53.0 |
回调失败
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
errNo | number | 错误码 | 2.53.0 |
errMsg | string | 错误信息 | 2.53.0 |
错误码说明:
errNo | errMsg | 说明 | 最低支持版本 |
---|---|---|---|
10101 | platform auth deny | 权限错误 | 2.53.0 |
20001 | param should be string, but got xxx | 参数类型校验错误 | 2.53.0 |
20001 | param awemeId is required | 缺少必传参数 | 2.53.0 |
21500 | The session id is unavailable, please check login status | 获取宿主 sessionid 失败,用户未登录 | 2.53.0 |
21501 | server error | 网络错误 | 2.53.0 |
21502 | server data error | 服务端网关错误 | 2.53.0 |
21100 | host open schema fail: %s, schema == %s | 宿主 openSchema 错误 | 2.53.0 |
21504 | room is not living | 直播间未处于开播状态 | 2.53.0 |
代码示例
<input
value="{{awemeId}}"
bindinput="changeAwemeId"
placeholder="请输入主播抖音号">
</input>
<button type="default" size="default" bindtap="openWebcastRoom">跳转直播间</button>
Page({
data: {
awemeId: "",
},
changeAwemeId(e) {
this.setData({
awemeId: e.detail.value,
});
},
openWebcastRoom() {
tt.openWebcastRoom({
awemeId: this.data.awemeId,
success(res) {
console.log("调用成功", res);
},
fail(res) {
console.log("调用失败", res);
},
});
},
});
Bug & Tip
- Tip:使用该接口时需要用户身份信息,请确保在调用接口前,用户已经登陆宿主 APP;
- Tip:目前该接口仅对白名单小程序开放,如需要使用,请下载飞书,搜索添加产品联系人杨璐嘉申请使用该功能的权限。
点击纠错
该文档是否对你的开发有所帮助?
有帮助
没帮助
该文档是否对你的开发有所帮助?
有帮助
没帮助