You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /企业直播/API 参考/认真度检测/获取认真度检测配置信息
获取认真度检测配置信息
最近更新时间：2024.06.25 12:10:43首次发布时间：2023.12.13 11:38:43
我的收藏

您可通过此接口获取指定直播间的切屏检测提醒、静音停播提醒等认真度检测配置信息。

注意事项

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

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是GetAttentionDetectionConfig接口名称。当前 API 的名称为 GetAttentionDetectionConfig。
VersionString是2023-08-01接口版本。当前 API 的版本为 2023-08-01。
ActivityIdLong是1783384368443直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。

返回参数

参数类型示例值描述
AttentionDetectionConfigArrayArray of AttentionDetectionConfigArray-认真度检测配置信息列表。

AttentionDetectionConfigArray

参数类型示例值描述

AttentionDetectionType

Integer

4

认真度检测类型。支持以下取值：

  • 1：观看前提示
  • 2：切屏检测提醒
  • 3：静音停播提醒
  • 4：无互动检测提醒

IsOpen

Integer

1

是否开启检测功能。支持以下取值：

  • 1：开启
  • 2：关闭
ReminderCopyString保持专注学习，多多参与学习互动哦提醒弹窗的提醒文案。
DetectionRuleObject of DetectionRule-认真度检测规则。

DetectionRule

参数类型示例值描述
MinTimeInteger600认真度检测提醒弹窗的弹出时间。例如观众与观看页面无互动（如移动鼠标等）达到该时间后，弹出提醒弹窗。单位为秒。

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20231127163926C6740782B6D034339B73",
        "Action": "GetAttentionDetectionConfig",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1701074367
    },
    "Result": {
        "AttentionDetectionConfigArray": [
            {
                "AttentionDetectionType": 1,
                "IsOpen": 1,
                "ReminderCopy": "观看学习过程中保持专注认真，请不要在学习过程中持续切屏、静音播放、挂机学习哦",
                "DetectionRule": {
                    "MinTime": 0
                }
            },
            {
                "AttentionDetectionType": 2,
                "IsOpen": 1,
                "ReminderCopy": "保持专注学习，请不要在学习过程中离开当前页面哦",
                "DetectionRule": {
                    "MinTime": 0
                }
            },
            {
                "AttentionDetectionType": 3,
                "IsOpen": 1,
                "ReminderCopy": "保持专注学习，请开启声音并持续收看哦",
                "DetectionRule": {
                    "MinTime": 30
                }
            },
            {
                "AttentionDetectionType": 4,
                "IsOpen": 1,
                "ReminderCopy": "保持专注学习，多多参与学习互动哦",
                "DetectionRule": {
                    "MinTime": 600
                }
            }
        ]
    }
}

错误码

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