开发
API

tt.openWebcastRoom

基础库 1.87.0 开始支持本接口。

提供从小程序跳转到直播间的能力。仅支持抖音 APP。

语法

tt.openWebcastRoom(options)

参数说明

options 为 Object 类型,属性如下:

属性名类型默认值必填说明最低支持版本
streamerIdstring--主播 id1.87.0
studioIdstring--直播间 id(主播 Id 和直播间 id 至少存在一个)1.87.0
successfunction--接口调用成功的回调函数1.87.0
failfunction--接口调用失败的回调函数1.87.0
completefunction--接口调用结束的回调函数(调用成功、失败都会执行)1.87.0

注:直播间 id 和主播 id 至少得存在一个。当主播 id 和直播间 id 同时存在时,直播间 id 的优先级更高。

回调成功

参数为 Object 类型,属性如下:

参数参数类型说明最低支持版本
errMsgstring回调信息1.87.0

回调失败

参数为 Object 类型,属性如下:

参数参数类型说明最低支持版本
errNonumber错误码1.87.0
errMsgstring错误信息1.87.0

错误码说明:

errNoerrMsg说明最低支持版本
10101platform auth deny权限错误1.89.0
20001param should be string, but got xxx参数类型校验错误1.96.0
20001param streamerId or studioId is required缺少必传参数1.96.0
21500The session id is unavailable, please check login status获取宿主 sessionid 失败,用户未登录1.89.0
21501server error网络错误1.89.0
21502server data error服务端网关错误1.89.0
21100host open schema fail: %s, schema == %s宿主 openSchema 错误1.87.0

代码示例

<input
	value="{{streamerId}}"
	bindinput="changeStreamerId"
	placeholder="请输入主播id">
</input>
<input
	value="{{studioId}}"
	bindinput="changeStudioId"
	placeholder="请输入直播间id">
</input>
<button type="default" size="default" bindtap="openWebcastRoom">跳转直播</button>
Page({
  data: {
    streamerId: "",
    studioId: "",
  },
  changeStreamerId(e) {
    this.setData({
      streamerId: e.detail.value,
    });
  },
  changeStudioId(e) {
    this.setData({
      studioId: e.detail.value,
    });
  },
  openWebcastRoom(e) {
    tt.openWebcastRoom({
      streamerId: this.data.streamerId,
      studioId: this.data.studioId,
      success(res) {
        console.log("调用成功", res);
      },
      fail(res) {
        console.log("调用失败", res);
      },
    });
  },
});

Bugs & Tips

  • Tips:使用该接口时需要用户身份信息,请确保在调用接口前,用户已经登陆宿主 APP。
  • Tips:目前该接口只支持抖音,所以请在抖音 APP 中调用。
  • Tips:目前该接口暂没有对外全量开放,如需要使用,请下载飞书,搜索添加产品联系人 赵邦 申请使用该功能的权限。。
点击纠错
评价此篇文档