最近更新时间:2023.12.13 11:38:43
首次发布时间:2023.12.13 11:38:43
更新认真度检测配置信息。
请求频率:单用户请求频率限制为 5 次/秒。
以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共请求参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | UpdateAttentionDetectionConfig | 接口名称。当前 API 的名称为 UpdateAttentionDetectionConfig 。 |
Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
ActivityId | Long | 是 | 1783308668443 | 直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。 |
AttentionDetectionConfigArray | Array of AttentionDetectionConfigArray | 是 | - | 认真度检测配置信息列表。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
IsOpen | Integer | 是 |
| 是否开启检测开关。支持以下取值:
|
ReminderCopy | String | 是 |
| 提醒弹窗的提醒文案。 说明 当 |
AttentionDetectionType | Integer | 是 |
| 认真度检测类型。支持以下取值:
|
DetectionRule | Object of DetectionRule | 否 |
| 认真度检测规则。 说明 仅当 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
MinTime | Integer | 否 | 600 | 认真度检测提醒弹窗的弹出时间。例如观众与观看页面无互动(如移动鼠标等)达到该时间后,弹出提醒弹窗。单位为秒。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
AttentionDetectionConfigArray | Array of AttentionDetectionConfigArrayResponse | - | 认真度检测配置信息列表。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
AttentionDetectionType | Integer |
| 认真度检测类型。支持以下取值:
|
IsOpen | Integer |
| 是否开启检测开关。支持以下取值:
|
ReminderCopy | String | 保持专注学习,多多参与学习互动哦 | 提醒弹窗的提醒文案。 |
DetectionRule | Object of DetectionRuleResponse | - | 认真度检测规则。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
MinTime | Integer | 600 | 认真度检测提醒弹窗的弹出时间。例如观众与观看页面无互动(如移动鼠标等)达到该时间后,弹出提醒弹窗。单位为秒。 |
POST https://livesaas.volcengineapi.com/?Action=UpdateAttentionDetectionConfig&Version=2023-08-01 { "ActivityId":1783308668443, "AttentionDetectionConfigArray":[ { "IsOpen":1, "ReminderCopy":"观看学习过程中保持专注认真,请不要在学习过程中持续切屏、静音播放、挂机学习哦", "AttentionDetectionType":1 }, { "IsOpen":1, "ReminderCopy":"保持专注学习,请不要在学习过程中离开当前页面哦", "AttentionDetectionType":2 }, { "IsOpen":1, "DetectionRule":{ "MinTime":30 }, "ReminderCopy":"保持专注学习,请开启声音并持续收看哦", "AttentionDetectionType":3 }, { "IsOpen":1, "DetectionRule":{ "MinTime":600 }, "ReminderCopy":"保持专注学习,多多参与学习互动哦", "AttentionDetectionType":4 } ] }
{ "ResponseMetadata": { "RequestId": "20231127163926C6740782B6D034339B73", "Action": "UpdateAttentionDetectionConfig", "Version": "2019-10-10", "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 } } ] } }
下表提供了该接口特有的错误码,公共错误码请参见公共错误码和错误码文档。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | InvalidParameter.AttentionDetectionTypeInvalid | The specified parameter AttentionDetectionType is invalid. | AttentionDetectionType 参数错误。请修改后重试。 |
400 | InvalidParameter.DetectionRuleInvalid | The specified parameter DetectionRule is invalid. | DetectionRule 参数错误。请修改后重试。 |
400 | InvalidParameter.ReminderCopyInvalid | The specified parameter ReminderCopy is invalid. | ReminderCopy 参数错误。请修改后重试。 |
400 | InvalidParameter.AttentionDetectionConfigArrayInvalid | The specified parameter AttentionDetectionConfigArray is invalid. | AttentionDetectionConfigArray 参数错误。请修改后重试。 |