GetQuizDataAPI - 获取直播间答题或简答详情--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

GetQuizDataAPI - 获取直播间答题或简答详情

最近更新时间：2025.03.24 16:50:55首次发布时间：2023.02.01 14:10:46

您可通过此接口获取直播间内指定答题或简答的详细信息，包括参与人数、答对人数以及选项内容等。

注意事项

请求频率：单用户请求频率限制为 120 次/分钟。
前提条件：确保您拥有火山引擎主账号或具备直播间的数据统计 > 仅查看或可编辑权限的子账号。有关如何添加子账号，详见子账号管理。

请求说明

请求方式：GET
请求地址：https://livesaas.volcengineapi.com/?Action=GetQuizDataAPI&Version=2020-06-01

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetQuizDataAPI`	接口名称。当前 API 的名称为 `GetQuizDataAPI`。
Version	String	是	`2020-06-01`	接口版本。当前 API 的版本为 `2020-06-01`。
ActivityId	Long	是	`177****287`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。说明使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。
QuizID	Integer	是	`177951****345672`	答题或简答 ID。您可通过调用 ListQuizStatisticsAPI 接口获取 ID。

返回参数

参数	类型	示例值	描述
TotalCount	Integer	`2`	参与人数。
RightCount	Integer	`1`	答对人数。
QuizOptions	Array of QuizOptions	`-`	答题或简答列表。

QuizOptions

参数	类型	示例值	描述
OptionSite	String	`A`	选项。
OptionName	String	`1`	选项内容。
OptionCount	String	`1`	选择该选项的人数。
OptionPercent	Integer	`50`	选择该选项的人数占总参与人数的百分比。

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetQuizDataAPI&Version=2020-06-01&ActivityId=177****287&QuizID=177951****345672

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetQuizDataAPI",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "TotalCount": 2,
        "RightCount": 1,
        "QuizOptions": [
            {
                "OptionSite": "A",
                "OptionName": "1",
                "OptionCount": "1",
                "OptionPercent": 50
            },
            {
                "OptionSite": "B",
                "OptionName": "2",
                "OptionCount": "1",
                "OptionPercent": 50
            }
        ]
    }
}

错误码

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