文档中心

企业直播

SDK API 参考

类型详情

Feature

类型：enum

功能。

属性	值	说明
cardlist	`'cardlist'`	商品卡片菜单及浮窗商品卡片。
coupon	`'coupon'`	卡券。

PortraitMenuIcon

类型：enum

竖屏直播间显示的图标。

属性	值	说明
shoppingCart	`'shoppingCart'`
share	`'share'`
info	`'info'`
images	`'images'`
notification	`'notification'`

LandscapePlayerIconKey

移动端横屏播放器支持配置的系统功能入口唯一标识。取值如下：

类型

'SYS:SUBTITLE_SWITCH'
| 'SYS:SHARE'
| 'SYS:LINE_SWITCH'
| 'SYS:LANGUAGE_SWITCH'
| 'SYS:DEFINITION_SWITCH'
| 'SYS:PLAYBACKRATE_SWITCH'
| 'SYS:NICKNAME_MODIFY'
| 'SYS:GIFT_SWITCH'
| 'SYS:NOTIFICATION_SWITCH'
| 'SYS:FEEDBACK'
| 'SYS:REPORT_ACTIVITY'

值	说明
`'SYS:SUBTITLE_SWITCH'`	字幕切换入口。
`'SYS:SHARE'`	分享入口。
`'SYS:LINE_SWITCH'`	频道切换入口。
`'SYS:LANGUAGE_SWITCH'`	语言切换入口。
`'SYS:DEFINITION_SWITCH'`	清晰度切换入口。
`'SYS:PLAYBACKRATE_SWITCH'`	倍速切换入口。
`'SYS:NICKNAME_MODIFY'`	昵称修改入口。
`'SYS:GIFT_SWITCH'`	礼物特效开关入口。
`'SYS:NOTIFICATION_SWITCH'`	互动特效开关入口。
`'SYS:FEEDBACK'`	帮助反馈入口。
`'SYS:REPORT_ACTIVITY'`	举报直播间入口。

LandscapePlayerIconPlacement

移动端横屏播放器系统功能入口的展示位置。取值如下：

类型

'bottom' | 'top' | 'topMore'

值	说明
`'bottom'`	底部控制区。底部控制区按 `index` 排序后最多展示前 2 个入口，超出的入口收入顶部更多面板。
`'top'`	顶部控制区。顶部控制区按 `index` 排序后最多展示前 2 个入口，超出的入口收入顶部更多面板。
`'topMore'`	顶部更多面板。

LandscapePlayerIconConf

类型：interface

移动端横屏播放器系统功能入口的单项展示配置。该配置用于覆盖对应系统入口的显隐、展示位置和同一位置内的顺序；未配置的系统入口继续使用默认规则和旧配置兼容逻辑。

key

类型：LandscapePlayerIconKey

系统功能入口的唯一标识。同一 key 重复配置时，后面的配置生效。

visible

类型：boolean | undefined

是否允许展示该系统功能入口。设置为 true 时仍需确保直播间能力、状态、权限、纯播放器模式和播放器就绪等条件。取值如下：

true：允许在满足上述条件时展示该入口。
false：不展示该入口。

默认值：true

placement

类型：LandscapePlayerIconPlacement | undefined

展示位置。未配置时使用系统默认展示位置。

index

类型：number | undefined

同一展示位置内的顺序，数值越小越靠前。同一位置内多个入口的 index 相同时，按系统默认入口顺序保持稳定排序。

默认值：无

IIcon

类型：interface

播放器内各功能按钮的图标。

play

类型：string | undefined

播放按钮的图标。

pause

类型：string | undefined

暂停按钮的图标。

volumeSmall

类型：string | undefined

调小音量按钮的图标。

volumeLarge

类型：string | undefined

调大音量按钮的图标。

volumeMuted

类型：string | undefined

静音按钮的图标。

openDanmu

类型：string | undefined

打开弹幕按钮的图标。

closeDanmu

类型：string | undefined

关闭弹幕按钮的图标。

fullscreen

类型：string | undefined

进入全屏模式按钮的图标。

exitFullscreen

类型：string | undefined

退出全屏模式按钮的图标。

pipIcon

类型：string | undefined

打开画中画模式按钮的图标。

pipIconExit

类型：string | undefined

退出画中画模式按钮的图标。

playbackRate

类型：string | undefined

选择倍速按钮的图标。

definition

类型：string | undefined

选择清晰度按钮的图标。

类型：string | undefined

移动端分享按钮的图标。

modify_nickname

类型：string | undefined

移动端修改昵称按钮的图标。

languageChange

类型：string | undefined

移动端语言切换按钮的图标。

notification

类型：string | undefined

移动端开启互动特效功能的图标。

notificationOff

类型：string | undefined

移动端关闭互动特效功能的图标。

giftEffect

类型：string | undefined

移动端开启礼物特效功能的图标。

giftEffectOff

类型：string | undefined

移动端关闭礼物特效功能的图标。

PluginConfigs

类型：interface

播放器内各功能按钮的相关设置。

type

类型："normal" | "inner" | undefined

功能按钮的展示位置。取值如下：

normal：进度条下面。仅当播放器控制栏的布局方式 controls.mode 取值为 normal 时，该取值才生效。详见配置参数。
inner：收起到更多图标（...）内。

position

类型：POSITIONS | undefined

功能按钮在进度条的左侧或右侧。仅当 type 取值为 normal 时，该参数才生效。

index

类型：number | undefined

功能按钮的显示顺序。仅当 type 取值为 normal 时，该参数才生效。

当 position 取值为 controlsLeft 时，数值越大，越靠右显示。
当 position 取值为 controlsRight 时，数值越大，越靠左显示。

disable

类型：boolean | undefined

是否隐藏功能按钮。取值如下：

true：隐藏。
false：不隐藏。

showText

类型：boolean | undefined

是否用文字替换图标。取值如下：

true：替换。文字内容为 IIcon 中设置的参数值。
false：不替换。图标为 IIcon 中设置的参数值。例如：icon:{play:"<img src =''图标 URL/>"}。

POSITIONS

类型：enum

播放器内各功能按钮在进度条的左侧或右侧。

属性	值	说明
CONTROLS_LEFT	`'controlsLeft'`	左侧。
CONTROLS_RIGHT	`'controlsRight'`	右侧。

ExternalReport

类型：interface

数据上报配置。

enable

类型：boolean | undefined

是否开启数据上报功能。默认值为 false。取值如下：

true: 开启。SDK 会在以下时机将数据上报至 url。
- 观众成功进入直播间时。
- 观众在直播间内，每间隔 repeatInterval 上报一次数据。
- 观众离开直播间时。
false: 不开启。

url

类型：string | undefined

通过 enable 开启数据上报功能后，SDK 会在指定时机将数据以 POST 方式上报至该 URL。

repeatInterval

类型：number | undefined

数据上报的时间间隔。单位为秒，默认值为 30。

DefinitionTextMap

类型：interface

观看页面不同清晰度对应的文案。key 为清晰度，value 为不同语言的文案。

请求示例

配置参数 liveDefinitionTextMap 默认值

配置参数 vodDefinitionTextMap 默认值

如需自定义文案，修改对应语言的文案即可。
{
auto: {
zh: '智能',
en: 'Auto',
jp: 'Auto',
'zh-hk': '智能',
},
origin: {
zh: '原画',
en: 'Orig',
jp: 'Orig',
'zh-hk': '原畫',
},
bd: {
zh: '蓝光',
en: '1080P Prem',
jp: '1080P Prem',
'zh-hk': '藍光',
},
uhd: {
zh: '超清',
en: '1080P',
jp: '1080P',
'zh-hk': '超清',
},
hd: {
zh: '高清',
en: '720P',
jp: '720P',
'zh-hk': '高清',
},
sd: {
zh: '标清',
en: '540P',
jp: '540P',
'zh-hk': '標清',
},
ld: {
zh: '流畅',
en: '240P',
jp: '240P',
'zh-hk': '流畅',
},
}

如需自定义文案，修改对应语言的文案即可。
{
'': {
zh: '智能',
en: 'Auto',
jp: 'Auto',
'zh-hk': '智能',
},
auto: {
zh: '智能',
en: 'Auto',
jp: 'Auto',
'zh-hk': '智能',
},
'1080p': {
zh: '蓝光',
en: '1080P Prem',
jp: '1080P Prem',
'zh-hk': '藍光',
},
'720p': {
zh: '超清',
en: '720P',
jp: '720P',
'zh-hk': '超清',
},
'540p': {
zh: '高清',
en: '540P',
jp: '540P',
'zh-hk': '高清',
},
'360p': {
zh: '标清',
en: '360P',
jp: '360P',
'zh-hk': '標清',
},
}

'zh-hk'

类型：string

繁体中文（中国香港）文案。

IErrorConfig

类型：interface

直播流中断后的行为配置信息。

retryDuration

类型：number | undefined

断流发生后，持续尝试重新连接的总时长。单位为毫秒。默认值为 300000（即 5 分钟）。如果超过此时长仍未连接成功，SDK 将停止重试，并显示企业直播默认的兜底图。建议配置不低于 30 秒。

errorTipsText

类型：string | undefined

断流发生且 SDK 正在尝试重试时，在播放器中展示的提示信息。默认值为 线路异常，请点击下方卡片切换其他线路。

类型：interface

菜单配置。

Name

类型：string

菜单名称。

Type

类型：number

菜单类型。取值如下：

1：图文介绍。
2：商品卡片。
3：聊天互动。
4：互动工具。
6：互动问答。
7：内嵌链接。
8：私聊互动。

Index

类型：number

菜单序号。

ProductV2

类型：interface

商品卡片配置。

EnableFloating

类型：boolean

是否开启浮层展示。取值如下：

true：开启。观众在移动端点击商品卡片后，在当前观看页以浮层形式展示商品详情页。观众可以在观看直播的同时查看商品详情页，实现边看边买。
false：关闭。观众点击商品卡片后，页面自动跳转至新的浏览器标签页展示商品详情页。观众无法同时观看直播与商品详情页。

EnableUA

类型：boolean

是否开启直达链接功能。该功能仅移动端支持。取值如下：

true：开启。
false：关闭。

UAInfos

类型：UAInfos[]

直达链接的配置信息。

说明

仅在 EnableUA 取值为 true 时生效。

EnableMiniApp

类型：boolean

是否开启微信小程序跳转功能。该功能仅移动端支持。取值如下：

true：开启。
false：关闭。

MiniAppId

类型：string

跳转的微信小程序的原始 ID。

说明

仅在 EnableMiniApp 取值为 true 时生效。

Product

类型：Product[]

商品配置信息。

ProductsPosition

类型：POSITION_MAP

浮窗商品卡片在 PC 端观看页的展示位置。

DisplayEnable

类型：number

商品卡片在观看页的入口。取值如下：

1：观看页支持展示商品卡片菜单和浮窗商品卡片。移动端观看页可同步展示购物车图标。

说明

移动端竖屏直播间仅支持展示购物车图标和浮窗商品卡片。
仅在启用聊天互动菜单后，移动端横屏直播间才会展示购物车图标。您可通过企业直播控制台或调用 ModifyActivityMenus 接口启用聊天互动菜单。有关如何通过企业直播控制台启用聊天互动菜单，详见聊天互动。

2：观看页仅支持展示浮窗商品卡片。

EnableViewCart

类型：boolean | undefined

是否在移动端商品卡片菜单的导航栏区域展示购物车图标。取值如下：

true：展示购物车图标。
false：不展示购物车图标。

ViewCartUrl

类型：string | undefined

移动端购物车图标的跳转链接。链接为空时，SDK 仍触发购物车点击事件，但不执行默认打开。

EnableViewOrder

类型：boolean | undefined

是否在移动端商品卡片菜单的导航栏区域展示订单图标。取值如下：

true：展示订单图标。
false：不展示订单图标。

ViewOrderUrl

类型：string | undefined

移动端订单图标的跳转链接。链接为空时，SDK 仍触发订单点击事件，但不执行默认打开。

ProductLinkConfig

类型：interface

商品卡片菜单的跳转配置，用于配置商品详情、加入购物车等入口的默认链接、UA 匹配链接和小程序直达链接。

Default

类型：string | undefined

默认 H5 跳转链接。未命中 UA 匹配链接或小程序直达链接时，SDK 使用该链接作为兜底链接。

UAList

类型：ProductLinkUAItem[] | undefined

UA 匹配跳转链接列表。SDK 会按商品菜单中的 UA 配置顺序匹配当前环境，命中后使用对应位置的链接。该参数仅在 EnableUA 取值为 true 时生效。

MiniApp

类型：ProductLinkMiniApp | undefined

移动端微信环境下的小程序直达链接。配置后，SDK 可在满足小程序跳转条件时打开对应小程序。该参数仅在 EnableMiniApp 取值为 true 时生效。

ProductMeta

类型：interface

商品卡片菜单的导航栏配置，用于控制移动端商品卡片菜单导航栏区域的购物车和订单图标。

EnableViewCart

类型：boolean | undefined

是否在移动端商品卡片菜单的导航栏区域展示购物车图标。取值如下：

true：展示购物车图标。
false：不展示购物车图标。

ViewCartUrl

类型：string | undefined

移动端购物车图标的跳转链接。链接为空时，SDK 仍触发购物车点击事件，但不执行默认打开。

EnableViewOrder

类型：boolean | undefined

是否在移动端商品卡片菜单的导航栏区域展示订单图标。取值如下：

true：展示订单图标。
false：不展示订单图标。

ViewOrderUrl

类型：string | undefined

移动端订单图标的跳转链接。链接为空时，SDK 仍触发订单点击事件，但不执行默认打开。

ProductCardClickSource

类型：'card' | 'floatingCard'

商品点击事件的入口来源类型。取值如下：

card：商品卡片菜单入口。
floatingCard：浮窗商品卡片入口。

UAInfos

类型：interface

直达链接的配置信息。

说明

仅在 EnableUA 取值为 true 时生效。

UAName

类型：string

环境名称，与 UAAddress 一一对应。

UAAddress

类型：string

环境 UA（User Agent），与 UAName 一一对应。

Product

类型：interface

商品配置信息。

Title

类型：string

商品名称。

Remark

类型：string

商品介绍。

Highlight

类型：string

商品的售卖价，即当前价格。

Strikethrough

类型：string

商品的参考价，即原价。

IntroduceImage

类型：string

商品图的 URL，包含协议头。

RedirectImage

类型：string

跳转图的 URL，包含协议头。

RedirectUrl

类型：string

跳转链接，即商品详情页的链接，包含协议头。如果观众无法跳转至直达链接或微信小程序，则会跳转至该链接。

DirectUrls

类型：string[]

直达链接，包含协议头。当观众在环境 UA 匹配成功的移动端平台上点击商品卡片时，即可跳转至该链接。

说明

仅在 EnableUA 取值为 true 时生效。

Index

类型：number

商品卡片的序号。

ExplainStatus

类型：number

商品讲解状态。取值如下：

0：未讲解。
1：讲解中。
2：讲解结束。

说明

仅在开启直播时移功能时生效。有关如何开启直播时移功能，详见直播时移。

FloatingStatus

类型：number

是否浮窗展示商品卡片。取值如下：

1：浮窗展示。
其他值：非浮窗展示。

说明

仅在未开启直播时移功能时生效。

FloatingTime

类型：number

浮窗商品卡片展示时间。Unix 时间戳，单位为秒。

ExplainTime

类型：number

最近一次修改商品讲解状态的时间。Unix 时间戳，单位为秒。取值为 0 表示未修改过商品讲解状态。您可以调用 seekVideo() 方法，跳转至商品讲解的时间点。

EnableStatus

类型：number

是否上架商品。取值如下：

0：下架。
1：上架。

MiniAppDirectUrl

类型：string

微信小程序链接，包含协议头。当观众在移动端微信环境点击商品卡片时，即可跳转至该微信小程序。

说明

仅在 EnableMiniApp 取值为 true 时生效。

DetailRedirectUrl

类型：ProductLinkConfig | undefined

商品详情入口的跳转配置。当观众点击商品图、商品名称、商品价格等商品信息区域后跳转。若未配置该项，观众点击商品信息区域后会跳转至 RedirectUrl 中配置的链接。

EnableAddCart

类型：boolean | undefined

是否开启商品的加入购物车功能，展示加购按钮。取值如下：

true：开启。
false：关闭。

AddCartUrl

类型：ProductLinkConfig | undefined

加入购物车图标的跳转配置。链接为空时，SDK 仍触发加入购物车点击（productAddCart.click）事件，但不执行默认打开。

SellingPointTag

类型：string

卖点标签。

ReminderType

类型：ReminderEnumType

在商品讲解期间的浮窗商品卡片和商品卡片菜单中，动效展示的提醒类型。

HotSale

类型：string

热卖提醒数量。

说明

仅在 ReminderType 取值为 1 时生效。

Stock

类型：string

库存提醒数量。

说明

仅在 ReminderType 取值为 2 时生效。

PromotionTagUrl

类型：string

活动标签的 URL，包含协议头。

PromotionTagType

类型：PromotionTagEnumType

活动标签类型。

IsOrderMsgEnable

类型：IsOrderMsgEnableEnum

是否开启下单消息。

OutOfStock

类型：IsOutOfStockEnum

是否售罄。

PriceHidden

类型：IsPriceHiddenEnum

是否隐藏价格。

MemberPrice

类型：string | undefined

会员价。

CustomContent

类型：string | undefined

通过服务端 OpenAPI 透传的自定义扩展信息。

ReminderEnumType

类型：enum

在商品讲解期间的浮窗商品卡片和商品卡片菜单中，动效展示的提醒类型。

属性	值	说明
NONE	`0`	无。
HOT	`1`	热卖。
STOCK	`2`	库存。

PromotionTagEnumType

类型：enum

活动标签类型。

属性	值	说明
NONE	`0`	无。
CUSTOM	`1`	自定义。
GREAT_VALUE_PURCHASE	`2`	超值购。
SURPRISE_OFFER	`3`	惊喜特惠。
LOW_PRICE_FLASH_SALE	`4`	低价秒杀。

IsOrderMsgEnableEnum

类型：enum

是否开启下单消息。

属性	值	说明
NONE	`0`	关闭下单消息。
SHOW	`1`	开启下单消息。

IsOutOfStockEnum

类型：enum

是否售罄。

属性	值	说明
NONE	`0`	取消售罄商品。
OUTOFSTOCK	`1`	售罄商品。

IsPriceHiddenEnum

类型：enum

是否隐藏价格。

属性	值	说明
NONE	`0`	展示价格。
HIDDEN	`1`	隐藏价格。

POSITION_MAP

类型：enum

浮窗商品卡片在 PC 端观看页的展示位置。

属性	值	说明
RT	`0`	播放器右上角。
LT	`1`	播放器左上角。
LB	`2`	播放器左下角。
RB	`3`	播放器右下角。

CommentItemOpenSDK

类型：interface

消息的配置信息。

Common

类型：Common

消息的基础信息，包括消息 ID、消息发送时间等。

Extra

类型：Extra

消息的扩展信息。

Common

类型：interface

消息的基础信息，包括消息 ID、消息发送时间等。

MsgId

类型：number

消息 ID。

CreateTime

类型：number

消息的发送时间，Unix 时间戳。

H5MsgId

类型：string

H5 页面生成的消息唯一标识。

LocalId

类型：string | undefined

本地消息 ID，用于临时标识尚未同步的消息。

Extra

类型：interface

消息的扩展信息。

TextContent

类型：string

消息文本内容。

ContentType

类型：MessageContentType | undefined

消息类型。

User

类型：User

发送消息的用户信息。

IsDelete

类型：boolean

消息是否已被删除。

IsSilence

类型：number

是否为禁言状态（1 表示禁言，0 表示正常）。

TextContentCn

类型：string

消息的中文内容或翻译。

TextContentEn

类型：string

消息的英文内容或翻译。

TextContentJp

类型：string

消息的日文内容或翻译。

TextContentKo

类型：string

消息的韩文内容或翻译。

IsSelfLike

类型：boolean

当前用户是否已点赞该消息。

LikeCount

类型：number

消息的点赞次数。

IsPresenter

类型：boolean

是否为主播发送的消息。

reviewStatus

类型：any

消息的审核状态。

LocalId

类型：string | undefined

本地消息 ID。

UploadItem

类型：UploadItem | undefined

上传的资源信息（如图片、表情等）。

operationInfo

类型：{ IsSendCommentEnable: boolean; } | undefined

主持人对消息的操作配置。

成员

名称类型说明

IsSendCommentEnable

名称	类型	说明
IsSendCommentEnable	`boolean`	是否允许观众发送评论。默认值为 `true`。 `true`：允许观众发送评论。 `false`：禁止观众发送评论。

boolean

是否允许观众发送评论。默认值为 true。

true：允许观众发送评论。

false：禁止观众发送评论。

welcomeInfo

类型：{ IsWelcomeEnable: boolean; } | undefined

主持人对欢迎消息的操作配置。

成员

名称类型说明

IsWelcomeEnable

名称	类型	说明
IsWelcomeEnable	`boolean`	是否开启欢迎消息。默认值为 `false`。 `true`：开启欢迎消息。 `false`：关闭欢迎消息。

boolean

是否开启欢迎消息。默认值为 false。

true：开启欢迎消息。

false：关闭欢迎消息。

IsOwn

类型：number | undefined

是否为当前用户发送的消息。取值如下：

1：是当前用户发送。
0：不是当前用户发送。

MessageContentType

类型：enum

定义消息内容的类型。

属性	值	说明
Text	`0`	普通文本消息。
Photo	`1`	图片消息。
Emoji	`2`	表情消息。
BigEmoji	`3`	仅支持单独发送（不可和文字合并发送）的表情消息。

User

类型：interface

用户信息。

Nickname

类型：string

用户昵称。

UserId

类型：any

用户 ID。

Email

类型：string

用户邮箱。

UploadItem

上传文件的信息。

类型

{
  uid: string;
  status?: UploadStatus;
  originFile?: File;
  percent?: number;
  response?: object;
  url?: string;
  name?: string;
}

成员

名称	类型	说明
uid	`string`	当前上传文件的唯一标识。
status	`UploadStatus \| undefined`	当前上传文件的状态。
originFile	`File \| undefined`	文件对象。
percent	`number \| undefined`	上传进度百分比。
response	`object \| undefined`	当前文件上传请求返回的响应。
url	`string \| undefined`	上传成功后文件的 URL。
name	`string \| undefined`	文件名。

UploadStatus

文件上传状态。取值如下：

'init': 初始状态。
'uploading': 上传中。
'done': 上传成功。
'error': 上传失败。

类型

'init' | 'uploading' | 'done' | 'error'

ProductConfig

类型：interface

企业直播服务端返回的商品卡片和菜单配置。

Menus

类型：Menu[]

菜单配置。

Product

类型：ProductV2

商品卡片配置。

OrderMsgInfo

类型：interface

商品消息和下单购买消息。

MsgType

类型：MsgEnumType

消息类型，包括查看商品消息（正在买）和下单购买消息（已下单）。

ProductId

类型：number

商品 ID。

UserName

类型：string

用户昵称。

SendTime

类型：number

消息发送时间，Unix 时间戳。

Count

类型：number

商品数量。

ProductInfo

类型：{ EnableFloating: boolean; EnableUA: boolean; UAAddress: string; UAInfos: UAInfos[]; EnableMiniApp: boolean; MiniAppId: string; Product: Product[]; ProductsPosition: POSITION_MAP; DisplayEnable: number; EnableViewCart?: boolean | undefined; ViewCartUrl?: string | undefined; EnableViewOrder?: boolean | undefined; ViewOrderUrl?: string | undefined; }

商品配置信息。详情参考 ProductV2。

MsgEnumType

类型：enum

查看商品消息和下单购买消息类型。

属性	值	说明
BUY	`1`	查看商品消息，对应观看页的正在买消息。
ORDER	`2`	下单购买消息，对应观看页的已下单消息。

TaskAwardConfig

类型：interface

本次累计观看抽奖活动的抽奖配置信息。

TaskAwardId

类型：string

本次累计观看抽奖活动的 ID。

TaskAwardStatus

类型：0 | 1 | 2 | 3

本次累计观看抽奖活动的状态。取值如下：

NULL(-1)：没有抽奖活动，预留字段。
INIT(0)：初始化，即未到活动开始时间。
START(1)：活动进行中。
END(2)：活动已结束。
CLOSE(3)：活动已关闭。

TaskAwardInstructions

类型：string

本次累计观看抽奖活动的活动文案。

TaskAwardIcon

类型：string

本次累计观看抽奖活动的抽奖图标。

TaskAwardRule

类型：TaskAwardRuleItem[]

抽奖规则。

TaskAwardStartTime

类型：number

本次累计观看抽奖活动的开始时间。Unix 秒级时间戳。

TaskAwardEndTime

类型：number

本次累计观看抽奖活动的结束时间。Unix 秒级时间戳。

TaskAwardRuleItem

类型：interface

累计观看抽奖的抽奖规则。

WatchTime

类型：number

累计观看时长要求。单位为分钟。

AwardItemName

类型：string

奖品的名称。

AwardItemIcon

类型：string

奖品的图标。

AwardItemType

类型：1 | 2 | 3 | 4

奖品类型。取值如下：

1：实物奖品。
2：虚拟奖品。
3：自定义奖品，即卡券奖品或积分奖品。
4：奖券奖品。

TaskAwardItemId

类型：string

奖品 ID。

AwardCount

类型：number

奖品的数量。

index

类型：number

奖品序号，第一个奖品序号为 0，第二个奖品序号为 1，以此类推。

IRecordInfo

类型：interface

当前观众的中奖记录。

AwardItemName

类型：string | undefined

抽奖名称。

TaskAwardItemId

类型：string

奖品 ID。

TaskAwardItemName

类型：string

奖品名称。

Status

类型：TaskAwardItemResult

中奖结果。

CreateTime

类型：number

中奖时间。Unix 秒级时间戳。

Phone

类型：string | undefined

收件人手机号。

Address

类型：string | undefined

收件人地址。

ReceiverName

类型：string | undefined

收件人姓名。

TaskAwardItemResult

类型：enum

中奖结果。

属性	值	说明
INIT	`-1`	初始化，即还未发布抽奖活动。
UNATTENDED	`0`	未参与抽奖。
WIN	`1`	中奖。
LOSE	`2`	未中奖。
ATTENDING	`3`	已参与抽奖。

AwardContext

类型：interface

实时抽奖配置信息。

DeadLine

类型：number

抽奖倒计时的分钟数。
在自动开奖模式下，抽奖结束时间的计算公式为：
结束时间 = SendTime + DeadLine * 60 + DeadLineSecond。

Name

类型：string

抽奖名称。

AwardType

类型：number

实时抽奖的开奖方式。取值含义如下：

1：自动开奖
2：手动开奖

BarragePwd

类型：string

弹幕口令。当配置为口令抽奖时，需要观众发送该口令参与抽奖。

ID

类型：number

抽奖 ID。

TotalCount

类型：number

当前抽奖的总参与人数。

Status

类型：number

抽奖状态。取值与服务端的 LotteryServerStatus 保持一致，含义如下：

0：未知状态（UNKNOWN）。
1：未开始（Init），尚未开启抽奖。
2：抽奖进行中（Ing），观众可以参与抽奖。
3：等待开奖（BeforeOpen），参与已结束，等待系统或主持人开奖。
4：已开奖（Opened），可以查看中奖结果。
5：已删除（Delete），该抽奖在后台被删除。
6：未开奖（UnOpened），活动结束后未进行开奖。
7：已撤回（Retract），该抽奖在后台被撤回。
8：正在开奖中（Opening），开奖过程进行中。

SendTime

类型：number

抽奖图文消息的发送时间，秒级 Unix 时间戳。

ShowPeopleNumber

类型：number

用于前端展示的人数文案，一般为预估或配置的展示人数。

AwardNum

类型：number

奖品总数。

WinnerInfoType

类型：string

中奖人需要填写的个人信息。取值如下：

1：收货地址
2：手机号
3：收件人
4：邮箱

AwardVersion

类型：number

抽奖配置版本号。用于兼容多奖品版本的抽奖配置。

ConditionType

类型：number

参与抽奖条件。支持以下取值：

0：无参与条件
1：参与答题或简答。即只有正确作答设置的题目数，才有资格参与抽奖

说明

该字段仅用于兼容实时抽奖功能旧逻辑，未与控制台奖品库功能关联。

ConditionVariable

类型：number

正确作答的题目数。

说明

该字段仅用于兼容实时抽奖功能旧逻辑，未与控制台奖品库功能关联。

AwardCondition

类型：IAwardCondition

参与抽奖条件。

AwardItemType

类型：number

奖品类型。取值如下：

1：实物奖品
2：虚拟奖品
3：卡券奖品或积分奖品
4：奖券奖品

AwardIcon

类型：string

抽奖图标的 URL。

AwardLotteryTicketAddr

类型：string

奖券奖品的领奖链接。仅当 AwardItemType 取值为 4 时，返回领奖链接，否则为空。

AwardThemeUrl

类型："bigTurntable" | "lotteryBox" | "slotMachine" | "noAnimation"

抽奖主题样式。取值如下：

bigTurntable：大转盘
lotteryBox：开奖箱
slotMachine：拉霸机
noAnimation：无动画

IsHideAwardNum

类型：0 | 1

是否在观看页展示奖品数量。取值如下：

0：展示奖品数量
1：不展示奖品数量

AwardItemConfigs

类型：IAwardItemConfig[]

奖品信息。

DeadLineSecond

类型：number | undefined

抽奖倒计时的秒数。在自动开奖模式下，与 DeadLine 一起用于计算结束时间。

AwardFloatingIcon

类型：string | undefined

抽奖浮标图标地址，用于在直播间内展示悬浮入口。

IsManualSendBarragePwd

类型：0 | 1 | undefined

是否需要观众发送弹幕口令。取值如下：

0：无需手动点击发送，弹幕口令将自动发送
1：需手动点击发送弹幕口令

IAwardCondition

类型：interface

实时抽奖参与条件的配置信息。

Quiz

类型：string

观众需要提交的答题或简答数。返回值为 all 表示需要提交直播开始后至观众参与抽奖前，直播间发布的所有答题或简答。

Questionnaire

类型：string

观众需要提交的问卷数。返回值为 all 表示需要提交直播开始后至观众参与抽奖前，直播间发布的所有问卷。

CheckIn

类型：string

观众需要提交的签到数。返回值为 all 表示需要提交直播开始后至观众参与抽奖前，直播间发布的所有签到。

Vote

类型：string

观众需要提交的投票数。返回值为 all 表示需要提交直播开始后至观众参与抽奖前，直播间发布的所有投票。

RightQuiz

类型：string

观众需要正确作答的题目数。返回值为 all 表示需要正确作答直播开始后至观众参与抽奖前，直播间发布的所有题目。

WatchLiveTime

类型：string

观众需要观看直播的时长。单位为分钟。

IAwardItemConfig

类型：interface

实时抽奖中的奖品详细配置信息。

AwardId

类型：number

奖品 ID。

AwardItemName

类型：string

奖品名称。

AwardItemCount

类型：number

奖品数量。

AwardItemType

类型：number

奖品类型。取值如下：

1：实物奖品。
2：虚拟奖品。
3：卡券奖品或积分奖品。
4：奖券奖品。

WinnerInfoType

类型：string

中奖人需要填写的个人信息。取值如下：

1：收货地址。
2：手机号。
3：收件人。
4：邮箱。

AwardItemIcon

类型：string

奖品图标的 URL，无协议头。

AwardLotteryTicketAddr

类型：string

奖券奖品的领奖链接。仅当 AwardItemType 取值为 4 时，返回领奖链接，否则为空。

AwardItemAmounts

类型：number

每位中奖观众可获得的积分数额。仅当 AwardItemType 取值为 3 时，返回中奖金额，否则取值为 0。你可以根据该中奖金额，判断向中奖观众发放多少积分。

AwardItemNum

类型：string

奖品标识。

若奖品类型为卡券奖品，该字段表示关联的卡券 ID。你可以通过该 ID，将当前卡券绑定你商城系统中的卡券，方便后续卡券的发放以及在商城内的核销。
若奖品类型为积分奖品，该字段表示积分奖品的批次号。你可以根据该批次号识别企业积分，向观众发放积分。

IAwardConditionAchieved

类型：interface

实时抽奖参与条件的达成状态信息。

AwardId

类型：number

实时抽奖 ID。

Condition

类型：{ CheckIn: boolean; WatchLiveTime: boolean; }

抽奖参与条件的达成详情。目前仅支持签到和观看直播时长。

成员

名称类型说明

CheckIn

名称	类型	说明
CheckIn	`boolean`	是否已达成签到条件。取值如下： `true`：已达成。 `false`：未达成。
WatchLiveTime	`boolean`	是否已达成观看直播时长条件。取值如下： `true`：已达成。 `false`：未达成。

boolean

是否已达成签到条件。取值如下：

true：已达成。

false：未达成。

WatchLiveTime

boolean

是否已达成观看直播时长条件。取值如下：

true：已达成。

false：未达成。

CheckInContext

类型：interface

签到配置信息。

CheckInName

类型：string

签到标题文案。

CheckInId

类型：string

签到 ID。

Status

类型：string

签到状态。取值如下：

Export：签到中
Deadline：已结束
Retract：已撤回

CheckInCount

类型：number

当前签到的总人数。

CheckInInfo

类型：string

需要观众填写个人信息时的提示文案。

DeadLine

类型：number

签到倒计时的分钟数。

NeedPersonInfo

类型：number

是否需要用户填写个人信息。取值如下：

0：不需要。
1：需要。

StartTime

类型：number

签到开始时间，秒级时间戳。

DeadlineSecond

类型：number

签到倒计时的秒数。签到总倒计时的计算公式为：总倒计时 = 倒计时分钟数 * 60 + 倒计时秒数。

CannotWatchLiveWhenNotCheckIn

类型：number

是否在未签到时自动踢出观众。取值如下：

0：不踢出。
1：踢出观众。

CannotWatchLivePrompt

类型：string

观众未签到时，踢出观众的提示文案。

IsSendComment

类型：number

是否在签到时自动发送评论。取值如下：

0：不发送评论
1：发送评论

CommentContent

类型：string

自动发送评论的文案。

isCheckIn

类型：boolean | undefined

当前观众是否已对该签到 ID 完成签到。该字段仅在 checkIn.receive 事件回调中返回。取值如下：

true：已完成签到。
false：未完成签到。

remainTime

类型：number | undefined

签到倒计时剩余时间。单位为秒。该字段仅在 checkIn.receive 事件回调中返回。计算逻辑为 max(0, floor(StartTime + DeadLine * 60 + DeadlineSecond - currentSystemTime))。

CouponContext

类型：interface

卡券的配置信息。

Count

类型：number

卡券数量。

Rule

类型：number

卡券的领取规则。

Duration

类型：number

卡券倒计时领取时的分钟数。

CutOffTime

类型：number

卡券定时截止领取时，设置的截止时间。Unix 时间戳，单位为秒。

Status

类型：CouponStatus

卡券状态。

Id

类型：number

卡券在互动工具中的标识。

PickupCount

类型：number

卡券领取数量。

Coupon

类型：{ Name: string; Description: string; ThirdPartyId: string; Pic: string; Id: number; }

卡券的详细信息。

成员

名称	类型	说明
Name	`string`	卡券名称。
Description	`string`	卡券描述。
ThirdPartyId	`string`	关联卡券 ID。即您自有商城系统中的卡券 ID。
Pic	`string`	卡券图标的 URL。包含协议头。
Id	`number`	卡券 ID。

AllowCloseIcon

类型：boolean

设置观众是否可以关闭观看页的卡券图标。取值如下：

true：允许观众关闭卡券图标。
false：不允许观众关闭卡券图标。

SendTime

类型：number

卡券发送时间。Unix 时间戳，单位为秒。

EndTime

类型：number

卡券截止领取时间。Unix 时间戳，单位为秒。

couponStatus

类型：CouponStatusType

用户领取卡券的状态。

LastSendTime

类型：number

卡券最后一次推送的时间。Unix 时间戳，单位为秒。

CouponStatus

类型：enum

卡券在发放端的状态。

属性	值	说明
Sending	`1`	发放中。
End	`2`	已结束。

CouponStatusType

类型：enum

卡券在观众端的领取状态。

属性	值	说明
Sending	`0`	发放中。观众可以领取卡券。
End	`1`	已结束。卡券发放已到达截止时间。
SendCompleted	`2`	已发完。卡券已全部被领取，库存已发放完毕。
Pickup	`3`	观众已在当前直播间成功领取该卡券。
Delete	`4`	已删除。
Received	`5`	观众领取数量已达到上限，无法继续领取。

最近更新时间：2026.08.14 17:10:24

这个页面对您有帮助吗？

有用

无用

企业直播

Feature #

PortraitMenuIcon #

LandscapePlayerIconKey #

LandscapePlayerIconPlacement #

LandscapePlayerIconConf #

key #

visible #

placement #

index #

IIcon #

play #

pause #

volumeSmall #

volumeLarge #

volumeMuted #

openDanmu #

closeDanmu #

fullscreen #

exitFullscreen #

pipIcon #

pipIconExit #

playbackRate #

definition #

share #

modify_nickname #

languageChange #

notification #

notificationOff #

giftEffect #

giftEffectOff #

PluginConfigs #

type #

position #

index #

disable #

showText #

POSITIONS #

ExternalReport #

enable #

url #

repeatInterval #

DefinitionTextMap #

zh #

en #

jp #

'zh-hk' #

IErrorConfig #

retryDuration #

errorTipsText #

Menu #

Name #

Type #

Index #

ProductV2 #

EnableFloating #

EnableUA #

UAInfos #

EnableMiniApp #

MiniAppId #

Product #

ProductsPosition #

DisplayEnable #

EnableViewCart #

ViewCartUrl #

EnableViewOrder #

ViewOrderUrl #

ProductLinkConfig #

Default #

UAList #

MiniApp #

ProductMeta #

EnableViewCart #

ViewCartUrl #

EnableViewOrder #

ViewOrderUrl #

ProductCardClickSource #

UAInfos #

UAName #

UAAddress #

Feature

PortraitMenuIcon

LandscapePlayerIconKey

LandscapePlayerIconPlacement

LandscapePlayerIconConf

key

visible

placement

index

IIcon

play

pause

volumeSmall

volumeLarge

volumeMuted

openDanmu

closeDanmu

fullscreen

exitFullscreen

pipIcon

pipIconExit

playbackRate

definition

share

modify_nickname

languageChange

notification

notificationOff

giftEffect

giftEffectOff

PluginConfigs

type

position

index

disable

showText

POSITIONS

ExternalReport

enable

url

repeatInterval

DefinitionTextMap

zh

en

jp

'zh-hk'

IErrorConfig

retryDuration

errorTipsText

Menu

Name

Type

Index

ProductV2

EnableFloating

EnableUA

UAInfos

EnableMiniApp

MiniAppId

Product

ProductsPosition

DisplayEnable

EnableViewCart

ViewCartUrl

EnableViewOrder

ViewOrderUrl

ProductLinkConfig

Default

UAList

MiniApp

ProductMeta

EnableViewCart

ViewCartUrl

EnableViewOrder

ViewOrderUrl

ProductCardClickSource

UAInfos

UAName

UAAddress

Product