更新答题或简答配置信息--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

更新答题或简答配置信息

最近更新时间：2024.10.10 11:20:21首次发布时间：2024.10.10 11:20:21

您可通过此接口更新指定直播间未发送的答题或简答的配置信息。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
前提条件：答题或简答未发送。您可调用 ListActivityQuizConfigs 接口，如果 QuizStatus 取值为 0，则表示答题或简答未发送。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdateActivityQuizConfig`	接口名称。当前 API 的名称为 `UpdateActivityQuizConfig`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。

Body

参数	类型	是否必选	示例值	描述
ActivityId	Long	是	`1770****83012`	直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。
QuizType	Long	是	`0`	类型。取值如下： `0`：答题 `1`：简答
Id	Long	是	`180848****212316`	答题或简答 ID。您可通过调用 ListActivityQuizConfigs 接口获取 ID。
QuizTitle	String	否	`答题 1`	答题或简答标题。默认为空。
QuizResultType	Integer	是	`1`	公布答案时机。取值如下： `0`：提交后自动公布答案 `1`：答题时间结束自动公布答案 `2`：手动公布答案
Deadline	Long	是	`30`	答题或简答限时。单位为秒。最小取值为 `10`。说明仅在 `QuizResultType` 取值为 `0` 或 `1` 时，该参数生效。
QuizOptions	Array of QuizOptions	是	`-`	选项信息。数组元素数量上限为 8。
RightOptions	Array of String	是	`["A"]`	正确答案。确保取值与本次调用中的某个 `OptionSite` 的取值相同。
QuizTitleType	Integer	是	`0`	题目类型。取值如下： `0`：单选 `1`：多选
QuizAnalysis	String	否	`1 的倒数是 1`	答案解析。默认为空。

QuizOptions

参数	类型	是否必选	示例值	描述
OptionSite	String	是	`A`	选项。
OptionName	String	否	`1`	选项内容。默认为空。说明该参数仅在 `QuizType` 取值为 `0` 时生效。

返回参数

参数	类型	示例值	描述
Status	Boolean	`true`	配置信息更新成功后，返回 `true`。
Id	Long	`180848****212316`	答题或简答 ID。

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateActivityQuizConfig&Version=2023-08-01
{
    "Id": 180848****212316,
    "ActivityId": 1770****83012,
    "QuizTitle": "答题 1",
    "QuizResultType": 1,
    "QuizOptions": [
        {
            "OptionSite": "A",
            "OptionName": "1"
        },
        {
            "OptionSite": "B",
            "OptionName": "-1"
        },
        {
            "OptionSite": "C",
            "OptionName": "0"
        },
        {
            "OptionSite": "D",
            "OptionName": "2"
        }

    ],
    "RightOptions": [
        "A"
    ],
    "Deadline": 30,
    "QuizTitleType": 0,
    "QuizAnalysis": "1 的倒数是 1",
    "QuizType": 0
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateActivityQuizConfig",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1721111109
    },
    "Result": {
        "Status": true,
        "Id": 180848****212316
    }
}

错误码

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

状态码	错误码	错误信息	说明
403	OperationDenied.QuizStatusNotMatchExpectedStatus	QuizStatus does not match the expected status	仅支持更新未发送的答题或简答的配置信息。请确保答题或简答的状态为未发送。