您可通过此接口更新指定直播间的外观主题、自定义点赞特效图的 URL 等基础配置信息。

注意事项

请求频率：单用户请求频率限制为 120 次/分钟。

请求说明

• 请求方式：POST
• 请求地址：https://livesaas.volcengineapi.com/?Action=UpdateActivityBasicConfigAPI&Version=2020-06-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。

Query

Body

SiteTags

TextSiteTags

RiskWarningSetting

返回参数

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateActivityBasicConfigAPI&Version=2020-06-01
{
  "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": 1,
  "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": "分类标签值"
    }
  ],
  "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": 4,
      "Value": "文本标签值"
    }
  ],
  "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": [
    "//p8-live.example.com/tos-cn-i:150:150.image"
  ],
  "UseDefaultThumbUpEffect": 1,
  "EndTime": 1718078834,
  "IsAutoEndEnable": 1
}

返回示例

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

错误码

下表提供了该接口特有的错误码，公共错误码请参见公共错误码和错误码文档。