您可通过此接口获取指定直播间的外观主题、自定义点赞特效图的 URL 等基础配置信息。
请求频率:单用户请求频率限制为 120 次/分钟。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetActivityBasicConfigAPI | 接口名称。当前 API 的名称为 GetActivityBasicConfigAPI 。 |
Version | String | 是 | 2020-06-01 | 接口版本。当前 API 的版本为 2020-06-01 。 |
ActivityId | Long | 是 | 1778177294933 | 直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
ActivityId | Long | 1778177294933 | 直播间 ID。 |
Name | String | 直播间 A | 直播间名称。 |
LiveTime | Long | 1698722520 | 直播开始时间。Unix 时间戳,单位为秒。 |
IsCoverImageEnable | Integer | 1 | 开启直播封面。取值固定为 1 。 |
CoverImageUrl | String |
| 横屏直播封面图的 URL。
|
CoverImageUrlDefault | String | //p1-live.example.com/tos-cn-i-gjr78lqtd0/~tplv-gjr78lqtd0-image.image | 默认横屏直播封面图的 URL,无协议头。 |
VerticalCoverImageUrl | String |
| 竖屏直播封面图的 URL。若未设置该参数值,则默认读取
|
IsPcBackImageEnable | Integer |
| 是否开启 PC 端背景图和背景颜色。取值如下:
|
PcBackImageUrl | String | //p6-live.example.com/tos-cn-i-gjr78lqtd0/.jpg~tplv-gjr78lqtd0-image.image | PC 端背景图的 URL。当 IsPcBackImageEnable 取值为 1 时,此处为 PC 端背景图的 URL,否则为空。 |
PcBackImageUrlDefault | String | https://p1-live.example.com/tos-cn-i-gjr78lqtd0/~tplv-gjr78lqtd0-image.image | 默认 PC 端背景图的 URL,有协议头。 |
IsMobileBackImageEnable | Integer |
| 是否开启移动端背景图和背景颜色。取值如下:
|
MobileBackImageUrl | String | //p1-live.example.com/tos-cn-i-gjr78lqtd0/~tplv-gjr78lqtd0-image.image | 移动端背景图的 URL。当 IsMobileBackImageEnable 取值为 1 时,此处为移动端背景图的 URL,否则为空。 |
MobileBackImageUrlDefault | String | https://p1-live.example.com/tos-cn-i-gjr78lqtd0/~tplv-gjr78lqtd0-image.image | 默认移动端背景图的 URL,有协议头。 |
MobileBackgroundColor | String | #060815 | 移动端背景颜色。遵循 RGB 色彩模型。当 IsMobileBackImageEnable 取值为 2 时,此处为移动端背景颜色,否则为空。 |
PcLoginBackgroundImageUrl | String |
| PC 端登录页背景图的 URL。
|
MobileLoginBackgroundImageUrl | String |
| 移动端登录页背景图的 URL。
|
IsPreviewVideoEnable | Integer |
| 是否开启预告片。取值如下:
|
PreviewVideoUrl | String | - | 已废弃 |
PreviewVideoVid | String | v03a49g10000ckkavibc77uejmsbrgag | 预告片 Vid。当 IsPreviewVideoEnable 取值为 1 时,此处为预告片 Vid,否则为空。 |
PreviewVideoVidDefault | String | - | 已废弃 |
IsPeopleCountEnable | Integer |
| 是否在观看页显示观看人数。取值如下:
|
IsHeaderImageEnable | Integer |
| 是否开启移动端页头图。取值如下:
|
HeaderImageUrl | String | //p1-live.example.com/tos-cn-i-gjr78lqtd0/~tplv-gjr78lqtd0-z75.image | 移动端页头图的 URL。当 IsHeaderImageEnable 取值为 1 时,此处为移动端页头图的 URL,否则为空。 |
IsWatermarkImageEnable | Integer |
| 是否在观看页显示 Logo。取值如下:
|
WatermarkImageUrl | String | //p1-live.example.com/tos-cn-i-gjr78lqtd0/~tplv-gjr78lqtd0-z75.image | Logo 的 URL。当 IsWatermarkImageEnable 取值为 1 时,此处为 Logo 的 URL,否则为空。 |
IsThumbUpEnable | Integer |
| 是否开启点赞。取值如下:
|
ThumbUpUrl | String | https://p1-live.example.com/tos-cn/image.image | 点赞图的 URL。当 IsThumbUpEnable 取值为 1 时,此处为点赞图的 URL,否则为空。 |
ThumbUpUrlDefault | String | https://p1-live.example.com/tos-cn-i-gjr78lqtd0/~tplv-gjr78lqtd0-image.image | 默认点赞图的 URL,有协议头。 |
UseDefaultThumbUpEffect | Integer |
| 使用系统默认还是自定义的点赞特效图。取值如下:
|
ThumbUpEffectUrls | Array of String |
| 自定义点赞特效图的 URL。当
|
IsShareIconEnable | Integer |
| 是否开启分享图标。取值如下:
|
ShareIconUrl | String | //p1-live.example.com/tos-cn-i-gjr78lqtd0/~tplv-gjr78lqtd0-z75.image | 分享图标的 URL。当 IsShareIconEnable 取值为 1 时,此处为分享图标的 URL,否则为空。 |
ShareIconUrlDefault | String | https://p1-live.example.com/tos-cn-i-/~tplv-gjr78lqtd0-image.image | 默认分享图标的 URL,有协议头。 |
IsCommentTranslateEnable | Integer | - | 已废弃 |
IsAnnouncementEnable | Integer |
| 是否开启直播描述。取值如下:
|
Announcement | String | 直播简介 | 直播描述。当 IsAnnouncementEnable 取值为 1 时,此处为直播描述,否则为空。 |
BackgroundColor | String | #060815 | PC 端背景颜色。遵循 RGB 色彩模型。当 IsPcBackImageEnable 取值为 2 时,此处为 PC 端背景颜色,否则为空。 |
InteractionColor | String | #202124 | PC 端互动区颜色。遵循 RGB 色彩模型。 |
FontColor | String | #ffffff | 字体颜色。遵循 RGB 色彩模型。 |
ColorThemeIndex | String |
| 外观主题。取值如下:
|
IsPCHeaderImageEnable | Integer |
| 是否开启 PC 端页头图。取值如下:
|
PCHeaderImageUrl | String | //p1-live.example.com/tos-cn-i-gjr78lqtd0/~tplv-gjr78lqtd0-z75.image | PC 端页头图的 URL。当 IsPCHeaderImageEnable 取值为 1 时,此处为 PC 端页头图的 URL,否则为空。 |
IsCountDownEnable | Integer |
| 是否开启直播倒计时。取值如下:
|
IsAutoStartEnable | Integer |
| 是否开启自动开播。取值如下:
|
IsPageLimitEnable | Integer |
| 是否开启页面限制。取值如下:
|
PageLimitType | String |
| 页面限制类型。当
|
IsLanguageEnable | Integer |
| 是否开启页面语言。取值如下:
|
LanguageType | Array of Integer |
| 页面语言类型。当
|
SiteTags | Array of SiteTags | - | 直播间分类标签信息列表。 |
TextSiteTags | Array of TextSiteTags | - | 直播间文本标签信息列表。 |
AutoStartType | Integer |
| 自动开播类型。当
|
PreviewVideoId | Long | 431674 | 预告片视频媒资库 ID。当 IsPreviewVideoEnable 取值为 1 时,此处为预告片视频媒资库 ID,否则为空。 |
AccountId | Long | - | 已废弃 |
PreviewVideoReviewStatus | Integer | - | 已废弃 |
DefaultSubtitleLanguage | String | - | 已废弃 |
SourceSubtitleLanguage | String | - | 已废弃 |
OpenLiveAvextractorTask | Integer | - | 已废弃 |
IsTimeShift | Integer |
| 是否开启时移功能。取值如下:
|
PreviewVideoCoverImage | String | http://p3-tt.example.cn/obj/tos-cn-v-c1801c/?dy_q=1697165259&l=20231013104739FC3D4AA45848F0BDACC3 | 预告片封面图的 URL。 |
PreviewVideoMediaName | String | 企业直播.mp4 | 预告片名称。 |
IsPreviewPromptEnable | Integer |
| 是否开启预告文案。取值如下:
|
PreviewPrompt | String | 直播即将开始,请稍候 | 预告文案。当 IsPreviewPromptEnable 取值为 1 时,此处为预告文案,否则为空。 |
IsReservationEnable | Integer |
| 是否开启直播预约功能。取值如下:
|
IsReservationSmsEnable | Integer |
| 是否开启预约短信提醒功能。取值如下:
说明 仅当 |
ReservationTime | Integer |
| 预约短信的发送时间,即直播开始前多久发送预约短信,单位秒。 说明 仅当 |
AutoReservationWindowEnable | Integer |
| 是否开启直播预约弹窗。取值如下:
说明 仅当 |
ReservationText | String | - | 已废弃 |
WatermarkPosition | Integer |
| Logo 的位置。取值如下:
|
IsReplayBulletChat | Integer | - | 已废弃 |
PresenterChatColor | String | #FFD58B | 主持人的字体颜色。遵循 RGB 色彩模型。 |
IsLiveBulletChat | Integer | - | 已废弃 |
IsBackgroundBlur | Integer |
| 是否开启背景模糊。取值如下:
|
FeedbackMessage | String | - | 已废弃 |
IsFeedbackEnable | Integer | - | 已废弃 |
IsThumbUpNumberEnable | Integer |
| 是否展示点赞数。取值如下:
|
SmsLanguage | Integer |
| 短信语言。取值如下:
|
MobileChatBackgroundColor | String | #000000 | 手机评论区背景颜色。遵循 RGB 色彩模型。 |
ConfigVersion | Integer | 1 | 配置版本,取值固定为 1 。 |
LiveZone | Integer |
| 时区。取值如下:
|
RiskWarningSetting | Object of RiskWarningSetting | - | 风险提示配置信息。 |
IsColorSync | Integer |
| 颜色配置是否同步到竖版直播间。取值如下:
|
IsPlayerTopEnable | Integer |
| 是否开启播放器置顶功能。取值如下:
|
PlayerTopType | Array of Integer |
| 播放器置顶的终端。取值如下:
|
IsReplayAutoOnlineEnable | Integer |
| 是否开启回放自动上架。取值如下:
|
ThumbUpEffectDefaultUrls | Array of String | ["//p1-live.example.com/tos-cn-i-gjr78lqtd0.image","//p1-live.example.com/tos-clv-gjr78lqtd0-resiz.image"] | 默认点赞特效图的 URL,无协议头。 |
EndTime | Long | 1718078834 | 直播结束时间。Unix 时间戳,单位为秒。 |
IsAutoEndEnable | Integer |
| 是否开启自动关播功能。取值如下:
|
LiveLayout | Integer |
| 直播模式。取值如下:
|
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Name | String | 分类标签 | 分类标签名称。 |
Value | String | 分类标签值 | 分类标签的标签值。 |
Index | Integer | 0 | 分类标签的索引值,用于标识分类标签在控制台展示的位置。取值范围为 [0,19]。 |
DbIndex | Integer | - | 已废弃。 |
Id | Integer | - | 已废弃。 |
Show | Integer | - | 已废弃。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Name | String | 文本标签 | 文本标签名称。 |
Value | String | 文本标签值 | 文本标签值。 |
Index | Integer | 0 | 文本标签的索引值,用于标识文本标签在控制台展示的位置。取值范围为 [0,4]。 |
DbIndex | Integer | - | 已废弃。 |
Id | Integer | - | 已废弃。 |
Show | Integer | - | 已废弃。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
IsRiskWarningEnable | Integer |
| 是否开启风险提示弹窗。取值如下:
|
RiskWarningButtonText | String | 我已知悉 | 风险提示按钮文案。 |
RiskWarningContent | String | 欢迎来到直播间,请遵守国家法律法规的要求,不要在直播间发布色情、违法、低俗、侵权等内容信息。同时请绿色健康参与直播,不以恶意手段破坏直播间正常秩序,做好直播间文明观众。如直播间主持人在推广商品中诱导私下交易,请谨慎判断,以免上当受骗。 | 风险提示内容。 |
RiskWarningTitle | String | 风险提示 | 风险提示标题。 |
GET https://livesaas.volcengineapi.com/?Action=GetActivityBasicConfigAPI&Version=2020-06-01&ActivityId=1778177294933
{ "ResponseMetadata": { "RequestId": "20231013105236E01591E988CE83C8677E", "Action": "GetActivityBasicConfigAPI", "Version": "2020-06-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1697165556 }, "Result": { "ActivityId": 1778177294933, "Name": "直播间 A", "LiveTime": 1698722520, "IsCoverImageEnable": 1, "CoverImageUrl": "//p1-live.example.com/tos-cn-i-gjr78lqtd0/~tplv-gjr78lqtd0-image.image", "CoverImageUrlDefault": "//p1-live.example.com/tos-cn-i-gjr78lqtd0/~tplv-gjr78lqtd0-image.image", "IsPcBackImageEnable": 1, "PcBackImageUrl": "//p6-live.example.com/tos-cn-i-gjr78lqtd0/.jpg~tplv-gjr78lqtd0-image.image", "PcBackImageUrlDefault": "https://p1-live.example.com/tos-cn-i-gjr78lqtd0/~tplv-gjr78lqtd0-image.image", "IsMobileBackImageEnable": 2, "MobileBackImageUrl": "//p1-live.example.com/tos-cn-i-gjr78lqtd0/~tplv-gjr78lqtd0-image.image", "MobileBackImageUrlDefault": "https://p1-live.example.com/tos-cn-i-gjr78lqtd0/~tplv-gjr78lqtd0-image.image", "IsPreviewVideoEnable": 1, "PreviewVideoUrl": "", "PreviewVideoVid": "v03a49g10000ckkavibc77uejmsbrgag", "PreviewVideoVidDefault": "http://previewvideo", "IsPeopleCountEnable": 1, "IsHeaderImageEnable": 1, "HeaderImageUrl": "//p1-live.example.com/tos-cn-i-gjr78lqtd0/~tplv-gjr78lqtd0-z75.image", "IsWatermarkImageEnable": 1, "WatermarkImageUrl": "//p1-live.example.com/tos-cn-i-gjr78lqtd0/~tplv-gjr78lqtd0-z75.image", "IsThumbUpEnable": 1, "ThumbUpUrl": "https://p1-live.example.com/tos-cn/image.image", "ThumbUpUrlDefault": "https://p1-live.example.com/tos-cn-i-gjr78lqtd0/~tplv-gjr78lqtd0-image.image", "IsShareIconEnable": 1, "ShareIconUrl": "//p1-live.example.com/tos-cn-i-gjr78lqtd0/~tplv-gjr78lqtd0-z75.image", "ShareIconUrlDefault": "https://p1-live.example.com/tos-cn-i-/~tplv-gjr78lqtd0-image.image", "IsCommentTranslateEnable": 0, "Announcement": "直播简介", "IsAnnouncementEnable": 1, "BackgroundColor": "#060815", "InteractionColor": "#202124", "FontColor": "#ffffff", "ColorThemeIndex": "dark", "IsPCHeaderImageEnable": 1, "PCHeaderImageUrl": "//p1-live.example.com/tos-cn-i-gjr78lqtd0/~tplv-gjr78lqtd0-z75.image", "IsCountdownEnable": 1, "IsAutoStartEnable": 1, "IsPageLimitEnable": 1, "PageLimitType": "pc", "IsLanguageEnable": 1, "LanguageType": [ 0, 1 ], "SiteTags": [ { "Index": 0, "Value": "分类标签值", "Name": "分类标签", "DbIndex": 1, "Show": 0, "Id": 0 } ], "AutoStartType": 1, "IsPlayerTopEnable": 1, "PlayerTopType": [ 1, 2 ], "IsReplayAutoOnlineEnable": 0, "PreviewVideoId": 431674, "AccountId": 0, "PreviewVideoReviewStatus": 2, "DefaultSubtitleLanguage": "", "SourceSubtitleLanguage": "", "OpenLiveAvextractorTask": 0, "IsTimeShift": 0, "PreviewVideoCoverImage": "http://p3-tt.example.cn/obj/tos-cn-v-c1801c/?dy_q=1697165259&l=20231013104739FC3D4AA45848F0BDACC3", "PreviewVideoMediaName": "企业直播.mp4", "IsPreviewPromptEnable": 1, "PreviewPrompt": "直播即将开始,请稍候", "IsReservationEnable": 1, "ReservationTime": 300, "ReservationText": "", "WatermarkPosition": 0, "IsReplayBulletChat": 0, "PresenterChatColor": "#FFD58B", "IsLiveBulletChat": 0, "IsBackgroundBlur": 0, "FeedbackMessage": "", "IsFeedbackEnable": 0, "IsThumbUpNumberEnable": 1, "SmsLanguage": 1, "MobileChatBackgroundColor": "#000000", "MobileBackgroundColor": "#060815", "ConfigVersion": 1, "LiveZone": 480, "RiskWarningSetting": { "IsRiskWarningEnable": 1, "RiskWarningTitle": "风险提示", "RiskWarningContent": "欢迎来到直播间,请遵守国家法律法规的要求,不要在直播间发布色情、违法、低俗、侵权等内容信息。同时请绿色健康参与直播,不以恶意手段破坏直播间正常秩序,做好直播间文明观众。如直播间主持人在推广商品中诱导私下交易,请谨慎判断,以免上当受骗。", "RiskWarningButtonText": "我已知悉" }, "IsColorSync": 1, "TextSiteTags": [ { "Index": 0, "Value": "文本标签值", "Name": "文本标签", "DbIndex": 1, "Show": 0, "Id": 0 } ], "IsReservationSmsEnable": 1, "VerticalCoverImageUrl": "//p1-live.example.com/tos-cn-i-gjr78lqtd0/eb504db09a5842cd9d32a927299259fc~tplv-gjr78lqtd0-z75.image", "PcLoginBackgroundImageUrl": "//p1-live.example.com.image", "MobileLoginBackgroundImageUrl": "//p6-live.example.com.image", "AutoReservationWindowEnable": 1, "ThumbUpEffectUrls": [], "ThumbUpEffectDefaultUrls": [ "//p1-live.example.com/tos-cn-i-gjr78lqtd0/b86221d071844ddfbca11a76bfb24919~tplv-gjr78lqtd0-resize:150:150.image", "//p1-live.example.com/tos-cn-i-gjr78lqtd0/d6698e2064b44116bf3fe668ead599d8~tplv-gjr78lqtd0-resize:150:150.image", "//p1-live.example.com/tos-cn-i-gjr78lqtd0/aa819be6901544a0a36ca9427e722401~tplv-gjr78lqtd0-resize:150:150.image", "//p1-live.example.com/tos-cn-i-gjr78lqtd0/bafc8cd5807c47dc9a509dca4d8473af~tplv-gjr78lqtd0-resize:150:150.image", "//p1-live.example.com/tos-cn-i-gjr78lqtd0/52fdb91f5b2f4558a0e199846c3d9159~tplv-gjr78lqtd0-resize:150:150.image" ], "UseDefaultThumbUpEffect": 1, "EndTime": 1718078834, "IsAutoEndEnable": 1, "LiveLayout": 2 } }