调用 UpdateActivityBasicConfigAPI
接口更新指定直播间的外观主题、自定义点赞特效图的 URL 等基础配置信息。
注意
在调用本接口前,您必须先调用 GetActivityBasicConfigAPI 接口。在调用本接口时,按需修改 GetActivityBasicConfigAPI
接口的返回参数值并传入本接口。为保证参数值不被替换为默认值,即便参数在该接口中为非必选,只要您有自定义的需求,就必须传入对应的参数值。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | UpdateActivityBasicConfigAPI | 接口名称。当前 API 的名称为 UpdateActivityBasicConfigAPI 。 |
Version | String | 是 | 2020-06-01 | 接口版本。当前 API 的版本为 2020-06-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
ActivityId | Long | 是 |
| 直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。 说明 使用子账号调用接口时,确保该直播间对子账号可见。有关如何配置子账号的可见范围,详见子账号管理。 |
Name | String | 是 | 直播间 A | 直播间名称。 |
LiveTime | Long | 否 |
| 直播开始时间。Unix 时间戳,单位为秒。支持精确到分钟级。 |
IsAutoEndEnable | Integer | 否 |
| 是否开启自动关播功能。支持以下取值,默认取值为
说明 直播过程中不支持修改该参数。 |
EndTime | Long | 否 |
| 直播结束时间。Unix 时间戳,单位为秒。支持精确到分钟级。 说明 当 |
IsCoverImageEnable | Integer | 否 |
| 是否开启直播封面。支持以下取值。默认取值为
|
CoverImageUrl | String | 否 |
| 横屏直播封面图的 URL。 说明 通常情况下,需要输入带协议头的 URL 作为参数值。但如果您获取到了通过企业直播控制台上传的图片的 URL(例如通过调用 GetActivityBasicConfigAPI 获取到了某直播间通过控制台上传的封面图的 URL),则该不带有协议头的 URL 可作为该参数的参数值。 |
VerticalCoverImageUrl | String | 否 |
| 竖屏直播封面图的 URL。若未设置该参数值,则默认读取 说明 通常情况下,需要输入带协议头的 URL 作为参数值。但如果您获取到了通过企业直播控制台上传的图片的 URL(例如通过调用 GetActivityBasicConfigAPI 获取到了某直播间通过控制台上传的封面图的 URL),则该不带有协议头的 URL 可作为该参数的参数值。 |
IsPcBackImageEnable | Integer | 否 |
| 是否开启 PC 端背景图和背景颜色。支持以下取值,默认取值为
|
PcBackImageUrl | String | 否 | //p1-live.example.com.image | PC 端背景图的 URL。当 IsPcBackImageEnable 取值为 1 时,该参数必填。 |
PcBackImageUrlDefault | String | 否 | //p1-live.example.com.image | 默认 PC 端背景图的 URL。 |
BackgroundColor | String | 否 | #060815 | PC 端背景颜色。遵循 RGB 色彩模型。当 IsPcBackImageEnable 取值为 2 时,该参数必填。仅支持传入 GetActivityBasicConfigAPI 接口中获取的背景颜色。 |
IsMobileBackImageEnable | Integer | 否 |
| 是否开启移动端背景图和背景颜色。支持以下取值,默认取值为
|
MobileBackImageUrl | String | 否 | //p1-live.example.com.image | 移动端背景图的 URL。。当 IsMobileBackImageEnable 取值为 1 时,该参数必填。 |
MobileBackImageUrlDefault | String | 否 | //p1-live.example.com.image | 默认移动端背景图的 URL。 |
MobileBackgroundColor | String | 否 | #060815 | 移动端背景颜色。遵循 RGB 色彩模型。当 IsMobileBackImageEnable 取值为 2 时,该参数必填。仅支持传入 GetActivityBasicConfigAPI 接口中获取的移动端背景颜色。 |
PcLoginBackgroundImageUrl | String | 否 |
| PC 端登录页背景图的 URL。 说明 通常情况下,需要输入带协议头的 URL 作为参数值。但如果您获取到了通过企业直播控制台上传的图片的 URL(例如通过调用 GetActivityBasicConfigAPI 获取到了某直播间通过控制台上传的封面图的 URL),则该不带有协议头的 URL 可作为该参数的参数值。 |
MobileLoginBackgroundImageUrl | String | 否 |
| 移动端登录页背景图的 URL。 说明 通常情况下,需要输入带协议头的 URL 作为参数值。但如果您获取到了通过企业直播控制台上传的图片的 URL(例如通过调用 GetActivityBasicConfigAPI 获取到了某直播间通过控制台上传的封面图的 URL),则该不带有协议头的 URL 可作为该参数的参数值。 |
IsPreviewVideoEnable | Integer | 否 |
| 是否开启预告片。支持以下取值,默认取值为
|
PreviewVideoVid | String | 否 | v03a49g10000ck****bc77uejmsbrgag | 预告片 Vid。当 IsPreviewVideoEnable 取值为 1 时,该参数必填。 |
PreviewVideoUrl | String | 否 | - | 已废弃 |
PreviewVideoVidDefault | String | 否 | - | 已废弃 |
IsPeopleCountEnable | Integer | 否 |
| 是否在观看页显示观看人数。支持以下取值,默认取值为
|
IsHeaderImageEnable | Integer | 否 |
| 是否开启移动端页头图。支持以下取值,默认取值为
|
HeaderImageUrl | String | 否 | //p1-live.example.com.image | 移动端页头图的 URL。当 IsHeaderImageEnable 取值为 1 时,该参数必填。 |
IsWatermarkImageEnable | Integer | 否 |
| 是否在观看页显示 Logo。支持以下取值,默认取值为
|
WatermarkImageUrl | String | 否 | //p1-live.example.com.image | Logo 的 URL。当 IsWatermarkImageEnable 取值为 1 时,该参数必填。 |
IsThumbUpEnable | Integer | 否 |
| 是否开启点赞。支持以下取值,默认取值为
|
ThumbUpUrl | String | 否 | https://p1-live.example.com.image | 点赞图的 URL。当 IsThumbUpEnable 取值为 1 时,该参数必填。 |
ThumbUpUrlDefault | String | 否 | https://p1-live.example.com.image | 默认点赞图的 URL。 |
UseDefaultThumbUpEffect | Integer | 否 |
| 使用系统默认还是自定义的点赞特效图。 默认取值为
|
ThumbUpEffectUrls | Array of String | 否 |
| 自定义点赞特效图的 URL。当 说明
|
IsShareIconEnable | Integer | 否 |
| 是否开启分享图标。支持以下取值,默认取值为
|
ShareIconUrl | String | 否 | //p1-live.example.com.image | 分享图标的 URL。当 IsShareIconEnable 取值为 1 时,该参数必填。 |
ShareIconUrlDefault | String | 否 | https://p1-live.example.com.image | 默认分享图标的 URL。 |
IsCommentTranslateEnable | Integer | 否 | - | 已废弃 |
IsAnnouncementEnable | Integer | 否 |
| 是否开启直播描述。支持以下取值,默认取值为
|
Announcement | String | 否 | 直播简介 | 直播描述。当 IsAnnouncementEnable 取值为 1 时,该参数必填。 |
InteractionColor | String | 否 | #202124 | PC 端互动区颜色。遵循 RGB 色彩模型。仅支持传入 GetActivityBasicConfigAPI 接口中获取的互动区颜色。 |
FontColor | String | 否 | #ffffff | 字体颜色。遵循 RGB 色彩模型。仅支持传入 GetActivityBasicConfigAPI 接口中获取的字体颜色。 |
ColorThemeIndex | String | 否 |
| 外观主题。支持以下取值,默认为
|
IsPCHeaderImageEnable | Integer | 否 |
| 是否开启 PC 端页头图。支持以下取值,默认取值为
|
PCHeaderImageUrl | String | 否 | //p1-live.example.com.image | PC 端页头图的 URL。当 IsPCHeaderImageEnable 取值为 1 时,该参数必填。 |
IsCountdownEnable | Integer | 否 |
| 是否开启倒计时。支持以下取值,默认取值为
|
IsAutoStartEnable | Integer | 否 |
| 是否开启自动开播。支持以下取值,默认取值为
|
AutoStartType | Integer | 否 |
| 自动开播类型。当
|
IsPageLimitEnable | Integer | 否 |
| 是否开启页面限制。支持以下取值,默认取值为
|
PageLimitType | String | 否 |
| 页面限制类型。当
|
IsLanguageEnable | Integer | 否 |
| 是否开启页面语言。支持以下取值,默认取值为
|
LanguageType | Array of Integer | 否 |
| 页面语言类型。当
|
SiteTags | Array of SiteTags | 否 | - | 直播间分类标签信息列表。 |
TextSiteTags | Array of TextSiteTags | 否 | - | 直播间文本标签信息列表。 |
PreviewVideoId | Long | 否 | 431674 | 预告片视频媒资库 ID。当 IsPreviewVideoEnable 取值为 1 时,该参数必填。 |
AccountId | Long | 否 | - | 已废弃 |
PreviewVideoReviewStatus | Integer | 否 | - | 已废弃 |
DefaultSubtitleLanguage | String | 否 | - | 已废弃 |
SourceSubtitleLanguage | String | 否 | - | 已废弃 |
OpenLiveAvextractorTask | Integer | 否 | - | 已废弃 |
IsTimeShift | Integer | 否 |
| 是否开启时移功能。支持以下取值,默认取值为
|
PreviewVideoCoverImage | String | 否 | http://p1-live.example.com.image | 预告片封面图的 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 色彩模型。仅支持传入 GetActivityBasicConfigAPI 接口中获取的主持人字体颜色。 |
IsLiveBulletChat | Integer | 否 | - | 已废弃 |
IsBackgroundBlur | Integer | 否 |
| 是否开启背景模糊。支持以下取值,默认取值为
|
FeedbackMessage | String | 否 | - | 已废弃 |
IsFeedbackEnable | Integer | 否 | - | 已废弃 |
IsThumbUpNumberEnable | Integer | 否 |
| 是否展示点赞数。支持以下取值,默认取值为
|
SmsLanguage | Integer | 否 |
| 短信语言。支持以下取值,默认取值为
|
MobileChatBackgroundColor | String | 否 | #000000 | 手机评论区背景颜色。遵循 RGB 色彩模型。仅支持传入 GetActivityBasicConfigAPI 接口中获取的手机评论区背景颜色。 |
ConfigVersion | Integer | 否 | 1 | 配置版本,取值固定为 1 。 |
LiveZone | Integer | 否 |
| 时区。支持以下取值,默认取值为
|
RiskWarningSetting | Object of RiskWarningSetting | 否 | - | 风险提示配置信息。 |
IsColorSync | Integer | 否 |
| 颜色配置是否同步到竖版直播间。支持以下取值,默认取值为
|
IsPlayerTopEnable | Integer | 否 |
| 是否开启播放器置顶功能。支持以下取值,默认取值为
|
PlayerTopType | Array of Integer | 否 |
| 播放器置顶的终端。当
|
IsReplayAutoOnlineEnable | Integer | 否 |
| 是否开启回放自动上架。支持以下取值,默认取值为
|
IsAvatarShowEnable | Integer | 否 |
| 是否在观看页展示观众头像。默认值为
说明 该参数仅用于设置是否在 SaaS 观看页、集成了 Web 观播 SDK 的观看页以及 iframe 嵌入观看页展示观众头像。如需在集成了 iOS 观播 SDK 的 App 中展示观众头像,可调用 landscapeShouldShowAvatar 和 portraitShouldShowAvatar 方法。 如需在集成了 Android 观播 SDK 的 App 中展示观众头像,可调用 setLandscapeCommentShouldShowAvatar 和 setPortraitCommentShouldShowAvatar 方法。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Value | String | 是 | 分类标签值 | 分类标签的标签值。 |
Index | Integer | 是 | 0 | 分类标签的索引值,用于标识分类标签在控制台展示的位置。取值范围为 [0,19]。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Value | String | 是 | 文本标签值 | 文本标签值。 |
Index | Integer | 是 | 0 | 文本标签的索引值,用于标识文本标签在控制台展示的位置。取值范围为 [0,4]。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
IsRiskWarningEnable | Integer | 是 |
| 是否开启风险提示弹窗。支持以下取值,默认取值为
|
RiskWarningButtonText | String | 是 | 我已知悉 | 风险提示按钮文案。 |
RiskWarningContent | String | 是 | 欢迎来到直播间,请遵守国家法律法规的要求 | 风险提示内容。 |
RiskWarningTitle | String | 是 | 风险提示 | 风险提示标题。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
ActivityId | Long | 1778****94933 | 直播间 ID。 |
ActivityIdStr | String | - | 已废弃 |
Status | Integer | - | 已废弃 |
POST https://livesaas.volcengineapi.com/?Action=UpdateActivityBasicConfigAPI&Version=2020-06-01
{
"ActivityId": 1778****94933,
"Name": "直播间 A",
"LiveTime": 1698722520,
"IsCoverImageEnable": 1,
"CoverImageUrl": "//p1-live.example.com.image",
"VerticalCoverImageUrl": "//p1-live.example.com.image",
"IsPcBackImageEnable": 1,
"PcBackImageUrl": "//p1-live.example.com.image",
"PcBackImageUrlDefault": "//p1-live.example.com.image",
"BackgroundColor": "#060815",
"IsMobileBackImageEnable": 1,
"MobileBackImageUrl": "//p1-live.example.com.image",
"MobileBackImageUrlDefault": "//p1-live.example.com.image",
"MobileBackgroundColor": "#060815",
"PcLoginBackgroundImageUrl": "//p1-live.example.com.image",
"MobileLoginBackgroundImageUrl": "//p1-live.example.com.image",
"IsPreviewVideoEnable": 1,
"PreviewVideoVid": "v03a49g10000ck****bc77uejmsbrgag",
"PreviewVideoUrl": "",
"PreviewVideoVidDefault": "",
"IsPeopleCountEnable": 1,
"IsHeaderImageEnable": 1,
"HeaderImageUrl": "//p1-live.example.com.image",
"IsWatermarkImageEnable": 1,
"WatermarkImageUrl": "//p1-live.example.com.image",
"IsThumbUpEnable": 1,
"ThumbUpUrl": "https://p1-live.example.com.image",
"ThumbUpUrlDefault": "https://p1-live.example.com.image",
"IsShareIconEnable": 1,
"ShareIconUrl": "//p1-live.example.com.image",
"ShareIconUrlDefault": "https://p1-live.example.com.image",
"IsCommentTranslateEnable": ,
"IsAnnouncementEnable": 1,
"Announcement": "直播简介",
"InteractionColor": "#202124",
"FontColor": "#ffffff",
"ColorThemeIndex": "dark",
"IsPCHeaderImageEnable": 1,
"PCHeaderImageUrl": "//p1-live.example.com.image",
"IsCountdownEnable": 1,
"IsAutoStartEnable": 1,
"AutoStartType": 1,
"IsPageLimitEnable": 1,
"PageLimitType": "pc",
"IsLanguageEnable": 1,
"LanguageType": [
0,
1
],
"SiteTags": [
{
"Value": "分类标签值",
"Index": 0
}
],
"TextSiteTags": [
{
"Value": "文本标签值",
"Index": 0
}
],
"PreviewVideoId": 431674,
"AccountId": ,
"PreviewVideoReviewStatus": ,
"DefaultSubtitleLanguage": "",
"SourceSubtitleLanguage": "",
"OpenLiveAvextractorTask": ,
"IsTimeShift": 0,
"PreviewVideoCoverImage": "http://p1-live.example.com.image",
"PreviewVideoMediaName": "企业直播.mp4",
"IsPreviewPromptEnable": 1,
"PreviewPrompt": "直播即将开始,请稍候",
"IsReservationEnable": 1,
"ReservationTime": 300,
"ReservationText": "",
"WatermarkPosition": 0,
"IsReplayBulletChat": ,
"PresenterChatColor": "#FFD58B",
"IsLiveBulletChat": ,
"IsBackgroundBlur": 0,
"FeedbackMessage": "",
"IsFeedbackEnable": ,
"IsThumbUpNumberEnable": 1,
"SmsLanguage": 1,
"MobileChatBackgroundColor": "#000000",
"ConfigVersion": 1,
"LiveZone": 480,
"RiskWarningSetting": {
"IsRiskWarningEnable": 1,
"RiskWarningTitle": "风险提示",
"RiskWarningContent": "欢迎来到直播间,请遵守国家法律法规的要求",
"RiskWarningButtonText": "我已知悉"
},
"IsColorSync": 1,
"IsPlayerTopEnable": 1,
"PlayerTopType": [
1,
2
],
"IsReplayAutoOnlineEnable": 0,
"AutoReservationWindowEnable": 1,
"IsReservationSmsEnable": 1,
"UseDefaultThumbUpEffect": 1,
"ThumbUpEffectUrls": [
"//p1-live.example.com.image"
],
"EndTime": 1718078834,
"IsAutoEndEnable": 1,
"IsAvatarShowEnable": 0
}
{
"ResponseMetadata": {
"RequestId": "20230604110420****100232280022D31",
"Action": "UpdateActivityBasicConfigAPI",
"Version": "2020-06-01",
"Service": "livesaas",
"Region": "cn-north-1",
"SystemTime": 1697446406
},
"Result": {
"ActivityId": 1778****94933,
"Status": 0,
"ActivityIdStr": "1778****94933"
}
}
下表提供了该接口特有的错误码,公共错误码请参见公共错误码和错误码文档。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
500 | 200001 | The EndTime cannot be earlier than now. | EndTime 不能早于当前时间。请修改后重试。 |
500 | 200001 | The EndTime cannot be earlier than the LiveTime. | EndTime 不能早于 LiveTime (直播开始时间)。请修改后重试。 |
500 | 200001 | The EndTime cannot be later than 72 hours from the LiveTime. | EndTime 与 LiveTime (直播开始时间)的差值不能大于 259,200,即 72 小时。请修改后重试。 |
500 | 200001 | The EndTime or IsAutoEndEnable cannot be modified during a live stream. | 直播过程中不支持修改 IsAutoEndEnable 和 EndTime 参数。 |