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

文档中心

立即注册

导航

获取答题或简答配置信息

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

您可通过此接口获取指定直播间的答题或简答配置信息。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述

ActivityId Long 是 1770****83012 直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。

参数	类型	是否必选	示例值	描述
ActivityId	Long	是	`1770****83012`	直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。
QuizType	Long	否	`0`	类型。默认值为 `0`。取值如下： `-1`：答题和简答 `0`：答题 `1`：简答
QuizStatus	Array of Integer	否	`[0,1,2,3,5]`	答题或简答状态。默认值为 `[0,1,2,3,5]`。取值如下： `0`：已初始化，即已创建但未发送 `1`：已发送 `2`：已手动公布答案。该参数值仅对历史数据生效 `3`：已结束 `4`：已删除 `5`：已撤回

QuizType

Long

否

0

类型。默认值为 0。取值如下：

-1：答题和简答
0：答题
1：简答

QuizStatus

Array of Integer

否

[0,1,2,3,5]

答题或简答状态。默认值为 [0,1,2,3,5]。取值如下：

0：已初始化，即已创建但未发送
1：已发送
2：已手动公布答案。该参数值仅对历史数据生效
3：已结束
4：已删除
5：已撤回

返回参数

参数	类型	示例值	描述
QuizConfigs	Array of QuizConfigs	`-`	答题或简答配置信息。

QuizConfigs

参数	类型	示例值	描述
ActivityId	Long	`1770****83012`	直播间 ID。
Id	Long	`180848****212316`	答题或简答 ID。
QuizTitle	String	`答题 1`	答题或简答标题。
QuizResultType	Integer	`0`	公布答案时机。取值如下： `0`：提交后自动公布答案 `1`：答题时间结束自动公布答案 `2`：手动公布答案
QuizOptions	Array of QuizOptions	`-`	选项信息。
RightOptions	Array of String	`["A"]`	正确答案。
Deadline	Long	`30`	答题或简答限时。单位为秒。
SendTime	Long	`1621111109`	发送时间。Unix 时间戳，单位为秒。若未发送，则取值为 `-1`。
QuizStatus	Integer	`1`	答题或简答状态。取值如下： `0`：已初始化，即已创建但未发送 `1`：已发送 `2`：已手动公布答案。仅历史数据存在该取值 `3`：已结束 `4`：已删除 `5`：已撤回
QuizTitleType	Integer	`1`	题目类型。取值如下： `0`：单选 `1`：多选
QuizAnalysis	String	`1 的倒数是 1`	答案解析。

QuizOptions

参数	类型	示例值	描述
OptionSite	String	`A`	选项。
OptionName	String	`1`	选项内容。说明该参数仅在 `QuizType` 取值为 `0` 时有值。
OptionCount	Long	`50`	选择该选项的人数。
OptionPercent	String	`100`	选择该选项的人数占总参与人数的百分比。

请求示例

POST https://livesaas.volcengineapi.com/?Action=ListActivityQuizConfigs&Version=2023-08-01
{
    "ActivityId": 1770****83012,
    "QuizType": 0,
    "QuizStatus": [
        0,
        1,
        2,
        3,
        5
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListActivityQuizConfigs",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1721111109
    },
    "Result": {
        "QuizConfigs": [
            {
                "Id": 180848****212316,
                "ActivityId": 1770****83012,
                "QuizTitle": "答题 1",
                "QuizResultType": 0,
                "QuizOptions": [
                    {
                        "OptionSite": "A",
                        "OptionName": "1",
                        "OptionCount": 50,
                        "OptionPercent": "100"
                    },
                {
                    "OptionSite": "B",
                    "OptionName": "-1",
                    "OptionCount": 0,
                    "OptionPercent": "0"
                },
                {
                    "OptionSite": "C",
                    "OptionName": "2",
                    "OptionCount": 0,
                    "OptionPercent": "0"
                },
                {
                    "OptionSite": "D",
                    "OptionName": "-2",
                    "OptionCount": 0,
                    "OptionPercent": "0"
                }
                ],
                "RightOptions": [
                    "A"
                ],
                "Deadline": 30,
                "SendTime": 1621111109,
                "QuizStatus": 1,
                "QuizTitleType": 0,
                "QuizAnalysis": "1 的倒数是 1"
            }
        ]
    }
}

错误码

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