最近更新时间：2024.03.14 12:17:06
首次发布时间：2024.03.14 12:17:06
通过本接口，更新指定直播间评论举报、全屏水印等安全管控功能的开启状态，以及全屏水印和跑马灯的配置信息。
请求频率：单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | UpdateSecurityControlConfig | 接口名称。当前 API 的名称为 UpdateSecurityControlConfig。 |
| Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| ActivityId | Long | 是 | 17925625415204 | 直播间 ID。您可通过 ListActivityAPI 接口查询 ID。 |
| SecurityControlCommonConfig | Object of SecurityControlCommonConfig | 否 | - | 安全管控配置信息。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
IsPlayPageWatermarkEnable | Integer | 否 |
| 是否开启全屏水印功能。支持以下取值：
|
IsModifyNicknameEnable | Integer | 否 |
| 是否开启昵称修改功能。支持以下取值：
|
IsSingleSignOnEnable | Integer | 否 |
| 是否开启禁止重复登录功能。支持以下取值：
|
IsAnonymousCommentEnable | Integer | 否 |
| 是否开启匿名评论功能。支持以下取值：
|
IsTipOffCommentEnable | Integer | 否 |
| 是否开启评论举报功能。支持以下取值：
|
IsPlayPageTickerEnable | Integer | 否 |
| 是否开启跑马灯功能。支持以下取值：
|
| WatermarkConfig | Object of WatermarkConfig | 否 | - | 全屏水印功能的配置信息。 |
| TickerConfig | Object of TickerConfig | 否 | - | 跑马灯功能的配置信息。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Content | String | 否 |
| 水印内容。最多支持输入 20 个字符。支持插入用户昵称或关联用户 ID 变量，以便为不同的观众展示独特的水印内容。例如水印内容为企业直播#用户昵称#，则昵称为用户 A 的观众看到的水印内容为企业直播用户 A。 |
FontSize | Integer | 否 |
| 水印字体的大小。支持以下取值，默认取值为
|
| FontColor | String | 否 | #737A87 | 水印字体的颜色。遵循 RGB 色彩模型。默认取值为 #737A87。 |
| Opacity | Integer | 否 | 10 | 水印字体的不透明度。取值范围为 [0,100]，默认取值为 10。 |
| Angle | Integer | 否 | 15 | 水印的倾斜角度。取值范围为 [-90,90]，默认取值为 15。例如 Angle 取值为 15，表示向右上方倾斜 15 度；Angle 取值为 -15，表示向右下方倾斜 15 度。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Content | String | 否 |
| 跑马灯内容。最多支持输入 20 个字符。支持插入用户昵称或关联用户 ID 变量，以便为不同的观众展示独特的跑马灯内容。例如跑马灯内容为企业直播#用户昵称#，则昵称为用户 A 的观众看到的跑马灯内容为企业直播用户 A。 |
DisplayType | Integer | 否 |
| 跑马灯的显示方式。支持以下取值，默认取值为
|
TickerSpeed | String | 否 |
| 跑马灯在播放器内滚动或闪烁的速度。支持以下取值，默认取值为
|
FontSize | Integer | 否 |
| 跑马灯字体的大小。支持以下取值，默认取值为
|
| FontColor | String | 否 | #737A87 | 跑马灯字体的颜色。遵循 RGB 色彩模型。默认取值为 #737A87。 |
| Opacity | Integer | 否 | 10 | 跑马灯字体的不透明度。取值范围为 [0,100]，默认取值为 10。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
Status | Boolean |
| 是否更新成功。支持以下取值：
|
POST https://livesaas.volcengineapi.com/?Action=UpdateSecurityControlConfig&Version=2023-08-01 { "ActivityId": 17925625415204, "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 } }