button 组件跳转抖音直播间

更新时间 2024-07-24 02:58:49

我的收藏

基础库 2.92.0 开始支持本能力。支持小程序打开直播间，需要将 button 组件 open-type 的值设置为 openWebcastRoom。
button 组件常规属性请参考button 按钮。

使用该功能前开发者需要至开发者后台-设置-关联设置-抖音号管理为对应的抖音号申请跳转抖音直播间能力，具体信息请参考引导跳转到直播间

属性说明

属性名	类型	默认值	必填	说明	最低支持版本
open-type	string		是	用于调用开放能力，此场景下需要设置为 "openWebcastRoom"	2.92.0
data-aweme-id	string		是	跳转直播间对应的主播抖音号，只支持小程序绑定的品牌号、员工号、合作号	2.92.0
bindopenwebcastroom	EventHandle		否	监听跳转的回调	2.92.0

bindopenwebcastroom 事件对象的 detail

回调成功

Object 类型，属性如下：

参数	参数类型	说明
errMsg	string	跳转成功信息，恒为`'openWebcastRoom:ok'`
errNo	number	0

回调失败

Object 类型，属性如下：

参数	参数类型	说明
errMsg	string	跳转失败信息，以`'openWebcastRoom:fail'`开头
errNo	number	错误代码

errMsg 的可枚举值：

errNo	errMsg	说明	最低支持版本
10101	platform auth deny	权限错误	2.92.0
20001	param should be string, but got xxx	参数类型校验错误	2.92.0
20001	param awemeId is required	缺少必传参数awemeId	2.92.0
21500	The session id is unavailable, please check login status	获取宿主 sessionid 失败，用户未登录	2.92.0
21501	server error	网络错误	2.92.0
21502	server data error	服务端网关错误	2.92.0
21100	host open schema fail: %s, schema == %s	宿主 openSchema 错误	2.92.0
21504	room is not living	直播间未处于开播状态	2.92.0
10401	awemeId not support	只支持小程序绑定的品牌号、员工号、合作号	2.92.0
10401	awemeId not exist	抖音号不存在	2.92.0

扫码体验

代码示例

开发者工具中预览

html复制
<button
  open-type="openWebcastRoom"
  bindopenwebcastroom="eventHandler"
  data-aweme-id="{{awemeId}}"
>
  跳转抖音直播间
</button>

js复制
Page({
  data: {
    awemeId: "跳转直播间对应的主播抖音号",
  },
  eventHandler(e) {
    if (e.detail.errNo) {
      console.log("跳转抖音直播间失败", e.detail);
    } else {
      console.log("跳转抖音直播间成功");
    }
  },
});