获取直播间安全管控配置信息--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

获取直播间安全管控配置信息

最近更新时间：2024.06.25 12:10:43首次发布时间：2024.03.14 12:17:05

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

注意事项

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetSecurityControlConfig`	接口名称。当前 API 的名称为 `GetSecurityControlConfig`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。
ActivityId	Long	是	`17965415204`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。

返回参数

参数	类型	示例值	描述
SecurityControlCommonConfig	Object of SecurityControlCommonConfig	`-`	安全管控配置信息。

SecurityControlCommonConfig

参数	类型	示例值	描述
IsAnonymousCommentEnable	Integer	`0`	是否开启匿名评论功能。支持以下取值： `0`：关闭 `1`：开启
IsModifyNicknameEnable	Integer	`1`	是否开启昵称修改功能。支持以下取值： `0`：关闭 `1`：开启
IsPlayPageTickerEnable	Integer	`1`	是否开启跑马灯功能。支持以下取值： `0`：关闭 `1`：开启
IsPlayPageWatermarkEnable	Integer	`0`	是否开启全屏水印功能。支持以下取值： `0`：关闭 `1`：开启
IsSingleSignOnEnable	Integer	`1`	是否开启禁止重复登录功能。支持以下取值： `0`：关闭 `1`：开启
IsTipOffCommentEnable	Integer	`1`	是否开启评论举报功能。支持以下取值： `0`：关闭 `1`：开启
TickerConfig	Object of TickerConfig	`-`	跑马灯功能的配置信息。
WatermarkConfig	Object of WatermarkConfig	`-`	全屏水印功能的配置信息。

TickerConfig

参数	类型	示例值	描述
Content	String	`#用户昵称#`	跑马灯内容。
DisplayType	Integer	`1`	跑马灯的显示方式。 `1`：滚动，即在播放器内以碰撞反弹方式展示。 `2`：闪烁，即在播放器内随机出现和消失。
FontColor	String	`#737A87`	跑马灯字体的颜色。遵循 RGB 色彩模型。
FontSize	Integer	`24`	跑马灯字体的大小。
Opacity	Integer	`10`	跑马灯字体的不透明度。
TickerSpeed	String	`Moderate`	跑马灯在播放器内滚动或闪烁的速度。支持以下取值： `Moderate`：适中 `Fast`：较快 `Slow`：较慢

WatermarkConfig

参数	类型	示例值	描述
Angle	Integer	`15`	全屏水印的倾斜角度。例如 `Angle` 取值为 `15`，表示向右上方倾斜 15 度；`Angle` 取值为 `-15`，表示向右下方倾斜 15 度。
Content	String	`#用户昵称#`	全屏水印内容。
FontColor	String	`#737A87`	全屏水印字体的颜色。遵循 RGB 色彩模型。
FontSize	Integer	`24`	全屏水印字体的大小。
Opacity	Integer	`10`	全屏水印字体的不透明度。

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetSecurityControlConfig&Version=2023-08-01&ActivityId=17965415204

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetSecurityControlConfig",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1705992306
    },
    "Result": {
        "SecurityControlCommonConfig": {
            "IsAnonymousCommentEnable": 0,
            "IsModifyNicknameEnable": 1,
            "IsPlayPageTickerEnable": 1,
            "IsPlayPageWatermarkEnable": 0,
            "IsSingleSignOnEnable": 1,
            "IsTipOffCommentEnable": 1,
            "TickerConfig": {
                "Content": "#用户昵称#",
                "DisplayType": 1,
                "FontColor": "#737A87",
                "FontSize": 24,
                "Opacity": 10,
                "TickerSpeed": "Moderate"
            },
            "WatermarkConfig": {
                "Angle": 15,
                "Content": "#用户昵称#",
                "FontColor": "#737A87",
                "FontSize": 24,
                "Opacity": 10
            }
        }
    }
}

错误码

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