您可通过此接口获取指定直播间评论举报、全屏水印等安全管控功能的开启状态,以及全屏水印和跑马灯的配置信息。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetSecurityControlConfig | 接口名称。当前 API 的名称为 GetSecurityControlConfig 。 |
Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01 。 |
ActivityId | Long | 是 |
| 直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。 说明 使用子账号调用接口时,确保该直播间对子账号可见。有关如何配置子账号的可见范围,详见子账号管理。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
SecurityControlCommonConfig | Object of SecurityControlCommonConfig | - | 安全管控配置信息。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
IsAnonymousCommentEnable | Integer |
| 是否开启匿名评论功能。支持以下取值:
|
IsModifyNicknameEnable | Integer |
| 是否开启昵称修改功能。支持以下取值:
|
IsPlayPageTickerEnable | Integer |
| 是否开启跑马灯功能。支持以下取值:
|
IsPlayPageWatermarkEnable | Integer |
| 是否开启全屏水印功能。支持以下取值:
|
IsSingleSignOnEnable | Integer |
| 是否开启禁止重复登录功能。支持以下取值:
|
IsTipOffCommentEnable | Integer |
| 是否开启评论举报功能。支持以下取值:
|
TickerConfig | Object of TickerConfig | - | 跑马灯功能的配置信息。 |
WatermarkConfig | Object of WatermarkConfig | - | 全屏水印功能的配置信息。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Content | String | #用户昵称# | 跑马灯内容。 |
DisplayType | Integer |
| 跑马灯的显示方式。
|
FontColor | String | #737A87 | 跑马灯字体的颜色。遵循 RGB 色彩模型。 |
FontSize | Integer | 24 | 跑马灯字体的大小。 |
Opacity | Integer | 10 | 跑马灯字体的不透明度。 |
TickerSpeed | String |
| 跑马灯在播放器内滚动或闪烁的速度。支持以下取值:
|
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
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": 1697446406
},
"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
}
}
}
}