You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /企业直播/API 参考/安全与审核/更新直播间安全管控配置信息
更新直播间安全管控配置信息
最近更新时间：2024.06.25 12:10:43首次发布时间：2024.03.14 12:17:06
我的收藏

您可通过此接口更新指定直播间评论举报、全屏水印等安全管控功能的开启状态，以及全屏水印和跑马灯的配置信息。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

  • 请求方式：POST
  • 请求地址：https://livesaas.volcengineapi.com/?Action=UpdateSecurityControlConfig&Version=2023-08-01

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是UpdateSecurityControlConfig接口名称。当前 API 的名称为 UpdateSecurityControlConfig。
VersionString是2023-08-01接口版本。当前 API 的版本为 2023-08-01。

Body

参数类型是否必选示例值描述
ActivityIdLong是17965415204直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。
SecurityControlCommonConfigObject of SecurityControlCommonConfig否-安全管控配置信息。

SecurityControlCommonConfig

参数类型是否必选示例值描述

IsPlayPageWatermarkEnable

Integer

否

1

是否开启全屏水印功能。支持以下取值，默认取值为 0。

  • 0：关闭
  • 1：开启

IsModifyNicknameEnable

Integer

否

0

是否开启昵称修改功能。支持以下取值，默认取值为 0。

  • 0：关闭
  • 1：开启

IsSingleSignOnEnable

Integer

否

0

是否开启禁止重复登录功能。支持以下取值，默认取值为 0。

  • 0：关闭
  • 1：开启

IsAnonymousCommentEnable

Integer

否

0

是否开启匿名评论功能。支持以下取值，默认取值为 0。

  • 0：关闭
  • 1：开启

IsTipOffCommentEnable

Integer

否

0

是否开启评论举报功能。支持以下取值，默认取值为 0。

  • 0：关闭
  • 1：开启

IsPlayPageTickerEnable

Integer

否

1

是否开启跑马灯功能。支持以下取值，默认取值为 0。

  • 0：关闭
  • 1：开启
WatermarkConfigObject of WatermarkConfig否-全屏水印功能的配置信息。
TickerConfigObject of TickerConfig否-跑马灯功能的配置信息。

WatermarkConfig

参数类型是否必选示例值描述

Content

String

否

#用户昵称#

全屏水印内容。最多支持输入 20 个字符。默认为#用户昵称#变量。
支持插入用户昵称或关联用户 ID 变量，以便为不同的观众展示独特的水印内容。例如水印内容为企业直播#用户昵称#，则昵称为用户 A 的观众看到的水印内容为企业直播用户 A。

说明

  • 插入变量的跑马灯内容，将根据观众的登录状态、变量类型等有所不同，具体如下：
    • 观众登录直播间前
      跑马灯内容为版权所有，严禁传播！。
    • 观众登录直播间后
      • 用户昵称变量：变量为观众昵称，但以下观看限制除外：
        • 手机号：变量为观众昵称 + 手机号后四位。有关如何将观看限制设置为手机号，详见手机号。
        • 白名单：变量为白名单信息。有关如何将观看限制设置为白名单，详见白名单。
      • 关联用户 ID 变量：变量为观众的关联用户 ID。如果观众不存在关联用户 ID，则变量为观众昵称。
  • 若同时配置用户昵称和关联用户 ID 变量时，跑马灯内容中的观众昵称仅显示一次。

FontSize

Integer

否

24

全屏水印字体的大小。支持以下取值，默认取值为 24。

  • 12
  • 16
  • 20
  • 24
  • 28
  • 32
  • 36
FontColorString否#737A87全屏水印字体的颜色。遵循 RGB 色彩模型。默认取值为 #737A87。
OpacityInteger否10全屏水印字体的不透明度。取值范围为 [0,100]，默认取值为 10。
AngleInteger否15全屏水印的倾斜角度。取值范围为 [-90,90]，默认取值为 15。例如 Angle 取值为 15，表示向右上方倾斜 15 度；Angle 取值为 -15，表示向右下方倾斜 15 度。

TickerConfig

参数类型是否必选示例值描述

Content

String

否

#用户昵称#

跑马灯内容。最多支持输入 20 个字符。默认为#用户昵称#变量。
支持插入用户昵称或关联用户 ID 变量，以便为不同的观众展示独特的跑马灯内容。例如跑马灯内容为企业直播#用户昵称#，则昵称为用户 A 的观众看到的跑马灯内容为企业直播用户 A。

说明

  • 插入变量的跑马灯内容，将根据观众的登录状态、变量类型等有所不同，具体如下：
    • 观众登录直播间前
      跑马灯内容为版权所有，严禁传播！。
    • 观众登录直播间后
      • 用户昵称变量：变量为观众昵称，但以下观看限制除外：
        • 手机号：变量为观众昵称 + 手机号后四位。有关如何将观看限制设置为手机号，详见手机号。
        • 白名单：变量为白名单信息。有关如何将观看限制设置为白名单，详见白名单。
      • 关联用户 ID 变量：变量为观众的关联用户 ID。如果观众不存在关联用户 ID，则变量为观众昵称。
  • 若同时配置用户昵称和关联用户 ID 变量时，跑马灯内容中的观众昵称仅显示一次。

DisplayType

Integer

否

1

跑马灯的显示方式。支持以下取值，默认取值为 1。

  • 1：滚动，即在播放器内以碰撞反弹方式展示。
  • 2：闪烁，即在播放器内随机出现和消失。

TickerSpeed

String

否

Moderate

跑马灯在播放器内滚动或闪烁的速度。支持以下取值，默认取值为 Moderate。

  • Moderate：适中
  • Fast：较快
  • Slow：较慢

FontSize

Integer

否

24

跑马灯字体的大小。支持以下取值，默认取值为 24。

  • 12
  • 16
  • 20
  • 24
  • 28
  • 32
  • 36
FontColorString否#737A87跑马灯字体的颜色。遵循 RGB 色彩模型。默认取值为 #737A87。
OpacityInteger否10跑马灯字体的不透明度。取值范围为 [0,100]，默认取值为 10。

返回参数

参数类型示例值描述

Status

Boolean

true

是否更新成功。支持以下取值：

  • true：成功
  • false：失败

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateSecurityControlConfig&Version=2023-08-01
{
    "ActivityId": 17965415204,
    "SecurityControlCommonConfig": {
        "IsPlayPageWatermarkEnable": 1,
        "IsModifyNicknameEnable": 0,
        "IsSingleSignOnEnable": 0,
        "IsAnonymousCommentEnable": 0,
        "IsTipOffCommentEnable": 0,
        "IsPlayPageTickerEnable": 1,
        "WatermarkConfig": {
            "Content": "#用户昵称#",
            "FontSize": 24,
            "FontColor": "#737A87",
            "Opacity": 10,
            "Angle": 15
        },
        "TickerConfig": {
            "Content": "#用户昵称#",
            "DisplayType": 1,
            "TickerSpeed": "Moderate",
            "FontSize": 24,
            "FontColor": "#737A87",
            "Opacity": 10
        }
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "UpdateSecurityControlConfig",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1673796954
    },
    "Result": {
        "Status": true
    }
}

错误码

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