You need to enable JavaScript to run this app.
最新活动
产品
解决方案
定价
生态与合作
支持与服务
开发者
了解我们
导航
企业直播
  • 文档首页
    • /
  • 企业直播

更新直播页面基础信息

最近更新时间：2023.07.04 10:34:39

首次发布时间：2022.03.29 22:10:12

我的收藏

本接口用于更新直播间页面中的基础配置，如直播背景图、预告片等。

注意

在调用本接口前，您必须先调用 GetActivityBasicConfigAPI 接口。在调用本接口时，按需修改 GetActivityBasicConfigAPI 接口的返回参数值并传入本接口。为保证参数值不被替换为默认值，即便参数在该接口中为非必选，只要您有自定义的需求，就必须传入对应的参数值。

请求说明

  • 接口名称：UpdateActivityBasicConfigAPI
  • 请求方式：POST
  • 接口地址：http://livesaas.volcengineapi.com/?Action=UpdateActivityBasicConfigAPI&Version=2020-06-01
  • 请求频率：单用户请求频率限制为 120 次/分钟。

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共请求参数。

Query

参数

类型

是否必选

描述

Action

String

是

接口名称

Version

String

是

接口版本。直播当前 API 的版本为 2020-06-01。

Body

参数

类型

是否必选

描述

ActivityId

Int64

是

直播间 ID。您可以通过调用 ListActivityAPI 接口查询 ID。

Name

String

是

直播间名称

LiveTime

Int64

否

直播开播时间。Unix 时间戳，单位为秒。

IsCoverImageEnable

Int32

否

开启直播封面。取值固定为 1。

CoverImageUrl

String

否

横屏直播封面图的 URL。当 IsCoverImageEnable 取值为 1 时，该参数必填。

  • 通过控制台方式配置横屏直播封面图时，封面图的 URL 不需要包括协议头。
  • 通过调用 API 接口配置横屏直播封面时，封面图的 URL 需要包括协议头。

CoverImageUrlDefault

String

否

默认横屏直播封面图的 URL，无协议头。

VerticalCoverImageUrl

String

否

竖屏直播的封面图 URL。若未设置该参数值，则默认读取 CoverImageUrl 的值。

  • 通过控制台方式配置竖屏直播封面图时，封面图的 URL 不需要包括协议头。
  • 通过调用 API 接口配置竖屏直播封面图时，封面图的 URL 需要包括协议头。

IsPcBackImageEnable

Int32

否

是否开启 PC 端背景图和背景颜色。支持以下取值，默认取值为 0。

  • 0：关闭背景图
  • 1：开启背景图
  • 2：开启背景颜色

PcBackImageUrl

String

否

PC 端背景图。当 IsPcBackImageEnable 取值为 1 时，该参数必填。

PcBackImageUrlDefault

String

否

默认 PC 端背景图的 URL。

BackgroundColor

String

否

PC 端背景颜色。当 IsPcBackImageEnable 取值为 2 时，该参数必填。仅支持传入 GetActivityBasicConfigAPI 接口中获取的背景颜色。

IsMobileBackImageEnable

Int32

否

是否开启移动端背景图和背景颜色。支持以下取值，默认取值为 0。

  • 0：关闭背景图
  • 1：开启背景图
  • 2：开启背景颜色

MobileBackImageUrl

String

否

移动端背景图。当 IsMobileBackImageEnable 取值为 1 时，该参数必填。

MobileBackImageUrlDefault

String

否

默认移动端背景图的 URL。

MobileBackgroundColor

String

否

移动端背景颜色。当 IsMobileBackImageEnable 取值为 2 时，该参数必填。仅支持传入 GetActivityBasicConfigAPI 接口中获取的移动端背景颜色。

PcLoginBackgroundImageUrl

String

否

PC 端登录页背景图的 URL。

  • 通过控制台方式配置 PC 端登录页背景图时，背景图的 URL 不需要包括协议头。
  • 通过调用 API 接口配置 PC 端登录页背景图时，背景图的 URL 需要包括协议头。

MobileLoginBackgroundImageUrl

String

否

移动端登录页背景图的 URL。

  • 通过控制台方式配置移动端登录页背景图时，背景图的 URL 不需要包括协议头。
  • 通过调用 API 接口配置移动端登录页背景图时，背景图的 URL 需要包括协议头。

IsPreviewVideoEnable

Int32

否

是否开启预告片。支持以下两种取值，默认取值为 0。

  • 0：关闭
  • 1：开启

PreviewVideoVid

String

否

预告片 Vid。当 IsPreviewVideoEnable 取值为 1 时，该参数必填。

PreviewVideoUrl

String

否

已废弃

PreviewVideoVidDefault

String

否

已废弃

IsPeopleCountEnable

Int32

否

是否开启显示人数。支持以下两种取值，默认取值为 0。

  • 0：关闭
  • 1：开启

IsHeaderImageEnable

Int32

否

是否开启移动端页头图。支持以下两种取值，默认取值为 0。

  • 0：关闭
  • 1：开启

HeaderImageUrl

String

否

移动端页头图的 URL。当 IsHeaderImageEnable 取值为 1 时，该参数必填。

IsWatermarkImageEnable

Int32

否

是否开启 Logo。支持以下两种取值，默认取值为 0。

  • 0：关闭
  • 1：开启

WatermarkImageUrl

String

否

Logo 的 URL。当 IsWatermarkImageEnable 取值为 1 时，该参数必填。

IsThumbUpEnable

Int32

否

是否开启点赞。支持以下两种取值，默认取值为 0。

  • 0：关闭
  • 1：开启

ThumbUpUrl

String

否

点赞图的 URL。当 IsThumbUpEnable 取值为 1 时，该参数必填。

ThumbUpUrlDefault

String

否

默认点赞图的 URL。

UseDefaultThumbUpEffect

Int

否

使用系统默认还是自定义的点赞特效图。 默认取值为 1。

  • 1：系统默认
  • 2：自定义

ThumbUpEffectUrls

Array of String

否

自定义点赞特效图的 URL。
当 IsThumbUpEnable 取值为 1 且UseDefaultThumbUpEffect 取值为 2 时，该参数必填。

  • 通过控制台方式配置自定义点赞特效图时，特效图的 URL 不需要包括协议头。
  • 通过调用 API 接口配置自定义点赞特效图时，特效图的 URL 需要包括协议头。

说明

最多支持配置 8 张自定义点赞特效图。

IsShareIconEnable

Int32

否

是否开启分享图标。支持以下两种取值，默认取值为 0。

  • 0：关闭
  • 1：开启

ShareIconUrl

String

否

分享图标的 URL。当 IsShareIconEnable 取值为 1 时，该参数必填。

ShareIconUrlDefault

String

否

默认分享图标的 URL。

IsCommentTranslateEnable

Int32

否

已废弃

IsAnnouncementEnable

Int

否

是否开启直播描述。支持以下两种取值，默认取值为 0。

  • 0：关闭
  • 1：开启

Announcement

String

否

直播描述。当 IsAnnouncementEnable 取值为 1 时，该参数必填。

InteractionColor

String

否

互动区颜色。仅支持传入 GetActivityBasicConfigAPI 接口中获取的互动区颜色。

FontColor

String

否

字体颜色。仅支持传入 GetActivityBasicConfigAPI 接口中获取的字体颜色。

ColorThemeIndex

String

否

外观主题。支持以下两种取值，默认为 dark。

  • light：清爽模式
  • dark：暗黑模式
  • cold：经典模式
  • holiday：传统节庆

IsPCHeaderImageEnable

Int32

否

是否开启 PC 端页头图。支持以下两种取值，默认取值为 0。

  • 0：关闭
  • 1：开启

PCHeaderImageUrl

String

否

PC 端页头图。当 IsPCHeaderImageEnable 取值为 1 时，该参数必填。

IsCountDownEnable

Int32

否

是否开启倒计时。支持以下两种取值，默认取值为 0。

  • 0：关闭
  • 1：开启

IsAutoStartEnable

Int32

否

是否开启自动开播。支持以下两种取值，默认取值为 0。

  • 0：关闭
  • 1：开启

AutoStartType

Int32

否

自动开播类型。当 IsAutoStartEnable 取值为 1 时，该参数必填。支持以下三种取值，默认取值为 0。

  • 0：不自动开播
  • 1：自动开始轮播
  • 2：自动开始拉流直播

IsPageLimitEnable

Int32

否

是否开启页面限制。支持以下两种取值，默认取值为 0。

  • 0：关闭
  • 1：开启

PageLimitType

String

否

页面限制类型。当 IsPageLimitEnable 取值为 1 时，该参数必填。支持以下两种取值。

  • pc：仅 PC 端可观看
  • mobile：仅移动端可观看

IsLanguageEnable

Int32

否

页面语言是否开启。支持以下两种取值，默认取值为 0。

  • 0：关闭
  • 1：开启

LanguageType

Array of Int32

否

页面语言类型。当 IsLanguageEnable 取值为 1 时，该参数必填。支持以下五种取值，默认取值为 0。

  • 0：简体中文
  • 1：英文
  • 2：日文
  • 3：繁体中文
  • 4：韩语

SiteTags

Array of ActTag

否

直播间分类标签列表

TextSiteTags

Array of TextActTag

否

直播间文本标签列表

PreviewVideoId

Int64

否

预告片视频媒体库的 ID

AccountId

Int64

否

已废弃

PreviewVideoReviewStatus

Int32

否

已废弃

DefaultSubtitleLanguage

String

否

已废弃

SourceSubtitleLanguage

String

否

已废弃

OpenLiveAvextractorTask

Int32

否

已废弃

IsTimeShift

Int32

否

是否开启时移功能。支持以下两种取值，默认取值为 0。

  • 0：不开启
  • 1：开启

PreviewVideoCoverImage

String

否

预告片封面图的 URL。

PreviewVideoMediaName

String

否

预告片名称

IsPreviewPromptEnable

Int32

否

是否开启预告文案。支持以下两种取值，默认取值为 0。

  • 0：不开启
  • 1：开启

PreviewPrompt

String

否

预告文案。当 IsPreviewPromptEnable 取值为 1 时，该参数必填。

IsReservationEnable

Int32

否

是否开启直播预约功能。支持以下两种取值，默认取值为 0。

  • 0：不开启
  • 1：开启

IsReservationSmsEnable

Int

否

是否开启预约短信提醒功能。支持以下两种取值，默认取值为 1。

  • 0：关闭
  • 1：开启

说明

仅当 IsReservationEnable 取值为 1 时，该配置生效。

ReservationTime

Int32

否

预约短信的发送时间，即直播开始前多久发送预约短信，单位为秒。

说明

仅当 IsReservationSmsEnable 取值为 1 时，该配置生效。

AutoReservationWindowEnable

Int

否

是否开启直播预约弹窗。支持以下两种取值，默认取值为 2。

  • 1：开启
  • 2：关闭

说明

  • 如果设置的参数值不是 1 或 2，则将参数值作为默认值 2 处理。
  • 仅当 IsReservationEnable 取值为 1 时，该配置生效。

ReservationText

String

否

已废弃

WatermarkPosition

Int32

否

Logo 的位置。支持以下四种取值，默认取值为 0。

  • 0：右上角
  • 1：左上角
  • 2：左下角
  • 3：右下角。

IsReplayBulletChat

Int32

否

已废弃

PresenterChatColor

String

否

主持人的字体颜色。仅支持传入 GetActivityBasicConfigAPI 接口中获取的主持人字体颜色。

IsLiveBulletChat

Int32

否

已废弃

IsBackgroundBlur

Int32

否

是否开启背景模糊。支持以下四种取值，默认取值为 0。

  • 0：不开启
  • 1：移动端开启
  • 2：PC 端开启
  • 3：移动端与 PC 端同时开启

FeedbackMessage

String

否

已废弃

IsFeedbackEnable

Int32

否

已废弃

IsThumbUpNumberEnable

Int32

否

是否展示点赞数。支持以下两种取值，默认取值为 0。

  • 0：不展示
  • 1：展示

SmsLanguage

Int32

否

短信语言。支持以下四种取值，默认取值为 0。

  • 0：自动
  • 1：中文
  • 2：英文
  • 3：中英双语

MobileChatBackgroundColor

String

否

手机评论区背景颜色。仅支持传入 GetActivityBasicConfigAPI 接口中获取的手机评论区背景颜色。

ConfigVersion

Int32

否

配置版本，取值固定为 1。

LiveZone

Int32

否

时区。支持以下取值，默认取值为 480。

  • -60：GMT-01:00 蓬塔德尔加达(葡萄牙)
  • -120：GMT-02:00 费尔南多-迪诺罗尼亚岛(巴西)
  • -180：GMT-03:00 巴西利亚(巴西)
  • -240：GMT-04:00 圣地亚哥(智利)
  • -300：GMT-05:00 华盛顿哥伦比亚特区(美国)
  • -360：GMT-06:00 墨西哥城(墨西哥)
  • -420：GMT-07:00 丹佛(美国)
  • -480：GMT-08:00 温哥华(加拿大)
  • -540：GMT-09:00 阿拉斯加(美国)
  • -570：GMT-09:30 泰奥哈埃(法属波利尼西亚)
  • -600：GMT-10:00 夏威夷(美国)
  • -660：GMT-11:00 阿洛菲(纽埃)
  • 0：GMT+00:00 伦敦(英国)
  • 60：GMT+01:00 巴黎(法国)
  • 120：GMT+02:00 大马革士(叙利亚)
  • 180：GMT+03:00 莫斯科(俄罗斯)
  • 210：GMT+03:30 德黑兰(伊朗)
  • 240：GMT+04:00 迪拜(阿联酋)
  • 300：GMT+05:00 新德里(印度)
  • 330：GMT+05:30 孟买(印度)
  • 360：GMT+06:00 达卡(孟加拉国)
  • 390：GMT+06:30 仰光(缅甸)
  • 420：GMT+07:00 曼谷(泰国)
  • 480：GMT+08:00 北京(中国)
  • 525：GMT+08:45 尤克拉(澳大利亚)
  • 540：GMT+09:00 东京(日本)
  • 570：GMT+09:30 达尔文(澳大利亚)
  • 600：GMT+10:00 堪培拉(澳大利亚)
  • 630：GMT+10:30 豪勋爵岛(澳大利亚)
  • 660：GMT+11:00 悉尼(澳大利亚)
  • 720：GMT+12:00 苏瓦(斐济)
  • 780：GMT+13:00 菲尼克斯群岛(基里巴斯)
  • 825：GMT+13:45 查塔姆群岛(新西兰)
  • 840：GMT+14:00 圣诞岛(基里巴斯)

RiskWarningSetting

RiskWarningSetting

否

风险提示配置

IsColorSync

Int32

否

颜色配置是否同步到竖版直播间。支持以下两种取值，默认取值为 0。

  • 0：不同步
  • 1：同步

IsPlayerTopEnable

Int32

否

是否开启播放器置顶功能。支持以下两种取值，默认取值为 0。

  • 0：不开启
  • 1：开启

PlayerTopType

Array of Int32

否

播放器置顶的终端。当 IsPlayerTopEnable 取值为 1 时，该参数必填。支持以下取值，默认取值为 [1,2]。

  • 0：关闭（已废弃）
  • 1：PC 端
  • 2：移动端

IsReplayAutoOnlineEnable

Int32

否

回放自动上架是否开启。支持以下两种取值，默认取值为 0。

  • 0：关闭；
  • 1：开启；

ActTag

参数

类型

是否必选

描述

Value

String

是

选定的分类标签值

Index

Int

是

分类标签索引标识。
取值范围：[0,19]

TextActTag

参数

类型

是否必选

描述

Value

String

是

文本标签值

Index

Int

是

文本标签索引标识。
取值范围：[0,4]

RiskWarningSetting

参数

类型

是否必选

描述

IsRiskWarningEnable

Int32

否

是否开启风险提示弹窗。支持以下两种取值，默认取值为 0。

  • 0：不开启
  • 1：开启

RiskWarningButtonText

String

否

风险提示按钮文案

RiskWarningContent

String

否

风险提示内容

RiskWarningTitle

String

否

风险提示标题

返回参数

参数

类型

描述

ActivityId

Int64

直播间 ID

ActivityIdStr

String

已废弃

Status

Int

已废弃

示例

请求示例

POST http://livesaas.volcengineapi.com/?Action=UpdateActivityBasicConfigAPI&Version=2020-06-01
{
    "ActivityId": 17471878477950,
    "Name": "直播间名称",
    "LiveTime": 1666258566,
    "IsCoverImageEnable": 1,
    "CoverImageUrl": "//gjr78lqtd0-image.image",
    "CoverImageUrlDefault": "//tplv-gjr78lqtd0-image.image",
    "VerticalCoverImageUrl": "//gjr78lqtd0-image.image",
    "IsPcBackImageEnable": 1,
    "PcBackImageUrl": "//tplv-gjr78lqtd0-image.image",
    "PcBackImageUrlDefault": "https://tplv-gjr78lqtd0-image.image",
    "IsMobileBackImageEnable": 1,
    "MobileBackImageUrl": "//tplv-gjr78lqtd0-image.image",
    "MobileBackImageUrlDefault": "tplv-gjr78lqtd0-image.image",
    "IsPreviewVideoEnable": 0,
    "PreviewVideoVid": "",
    "PreviewVideoUrl": "",
    "PreviewVideoVidDefault": "",
    "IsPeopleCountEnable": 0,
    "IsHeaderImageEnable": 0,
    "HeaderImageUrl": "",
    "IsWatermarkImageEnable": 0,
    "WatermarkImageUrl": "",
    "IsThumbUpEnable": 0,
    "ThumbUpUrl": "",
    "ThumbUpUrlDefault": "",
    "UseDefaultThumbUpEffect":1, 
    "ThumbUpEffectUrls":"",  
    "IsShareIconEnable": 0,
    "ShareIconUrl": "",
    "ShareIconUrlDefault": "https://tplv-gjr78lqtd0-image.image",
    "IsCommentTranslateEnable": 0,
    "Announcement": "",
    "IsAnnouncementEnable": 0,
    "BackgroundColor": "#060815",
    "InteractionColor": "#202124",
    "FontColor": "#ffffff",
    "ColorThemeIndex": "dark",
    "IsPCHeaderImageEnable": 0,
    "PCHeaderImageUrl": "",
    "IsCountdownEnable": 0,
    "IsAutoStartEnable": 0,
    "AutoStartType": 0,
    "IsPageLimitEnable": 0,
    "PageLimitType": "",
    "IsLanguageEnable": 0,
    "LanguageType": [],
    "SiteTags": [],
    "IsPlayerTopEnable": 0,
    "PlayerTopType": [],
    "IsReplayAutoOnlineEnable": 0,
    "PreviewVideoId": 0,
    "AccountId": 0,
    "PreviewVideoReviewStatus": 0,
    "DefaultSubtitleLanguage": "",
    "SourceSubtitleLanguage": "",
    "OpenLiveAvextractorTask": 0,
    "IsTimeShift": 0,
    "PreviewVideoCoverImage": "",
    "PreviewVideoMediaName": "",
    "IsPreviewPromptEnable": 0,
    "PreviewPrompt": "直播即将开始，请稍候",
    "IsReservationEnable": 0,
    "IsReservationSmsEnable": 0,
    "ReservationTime": 0,
    "AutoReservationWindowEnable": 2,
    "ReservationText": "",
    "WatermarkPosition": 0,
    "IsReplayBulletChat": 0,
    "PresenterChatColor": "#FFD58B",
    "IsLiveBulletChat": 0,
    "IsBackgroundBlur": 0,
    "FeedbackMessage": "",
    "IsFeedbackEnable": 0,
    "IsThumbUpNumberEnable": 1,
    "SmsLanguage": 0,
    "MobileChatBackgroundColor": "#000000",
    "MobileBackgroundColor": "#060815",
    "ConfigVersion": 1,
    "LiveZone": 480,
    "RiskWarningSetting": {
        "IsRiskWarningEnable": 0,
        "RiskWarningTitle": "",
        "RiskWarningContent": "",
        "RiskWarningButtonText": ""
    },
    "IsColorSync": 0,
    "TextSiteTags": [],
    "PcLoginBackgroundImageUrl": "",
    "MobileLoginBackgroundImageUrl": ""
}

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "UpdateActivityBasicConfigAPI",
        "Version": "2020-06-01", 
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1656067132
    }
    "Result": {
            "ActivityId": 17471878477950,
            "ActivityIdStr": "17471878477950",
            "Status": 0
    }
}

异常返回示例

{
    "ResponseMetadata":{
        "RequestId":"201806041104200100100232280022D30",
        "Action":"UpdateActivityBasicConfigAPI",
        "Version":"2020-06-01", 
        "Service":"livesaas",
        "Region":"cn-north-1",
        "SystemTime":1656067132,
        "Error":{
            "Code":"200000",
            "Message":"参数异常"
        }
    }
}

错误码

访问公共错误码获取详细信息。