You need to enable JavaScript to run this app.
最新活动
产品
解决方案
定价
生态与合作
支持与服务
开发者
了解我们
导航

获取直播间答题参与名单

最近更新时间2023.02.01 14:10:46

首次发布时间2023.02.01 14:10:46

获取直播间答题的参与观众名单。

请求说明

  • 接口名称:ListQuizRecordAPI
  • 请求方式:GET
  • 接口地址:http://livesaas.volcengineapi.com/?Action=ListQuizRecordAPI&Version=2020-06-01
  • 请求频率:单用户请求频率限制为 120 次/分钟

请求参数

以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共请求参数

Query

参数类型是否必选描述
ActionString接口名称
VersionString接口版本。直播当前 API 的版本为 2020-06-01
ActivityIdInt直播间 ID。您可以通过调用 ListActivityAPI 接口查询 ID
PageNoInt分页查询页码,默认取值为 1
PageItemCountInt分页查询数量,默认取值为 10
QuizIDInt答题 ID。您可以通过调用 ListQuizStatisticsAPI 接口查询 ID

返回参数

参数类型描述
PageNoInt分页查询页码
PageItemCountInt分页查询数量
PageTotalCountInt查询结果总数
QuizStatisticsListArray of QuizRecord答题参与名单列表

QuizRecord

参数类型描述
UserIDInt观众 ID
UserNameString观众昵称
UserTelstring观众手机号
EmailString观众邮箱
CreateTimeInt观众提交答题的时间,Unix 时间戳,单位为秒

IsRight

Bool

答题情况

  • true:回答正确
  • false:回答错误
ExtraString业务方扩展参数
UserAgentString观众终端设备
IpString观众的 IP 地址
ExternalIdString观众在第三方平台的唯一标识。您可以根据该关联用户 ID 识别企业自身的用户身份,以便于按需实现用户洞察和进行数据分析。观众通过不同方式登录直播间时,关联用户 ID 取值不同,具体取值情况详见数据统计
SubmitOptionsArray of String观众提交的答案

示例

请求示例

Get http://livesaas.volcengineapi.com/?Action=ListQuizRecordAPI&Version=2020-06-01&ActivityId=1231231231&QuizID=1754628061265087

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230110191103E1E36F18E6672AFA7982",
        "Action": "ListQuizRecordAPI",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1673349063
    },
    "Result": {
        "PageNo": 1,
        "PageItemCount": 10,
        "PageTotalCount": 1,
        "QuizStatisticsList": [
            {
                "UserID": 1738686737584142,
                "UserName": "观众 A",
                "UserTel": "152*****365",
                "Email": "zhibo@xxxx.com",
                "CreateTime": 1673348952,
                "IsRight": false,
                "Extra": "abc",
                "UserAgent": "Intel Mac OS X 10_15_7",
                "Ip": "10.255.255.157", 
                "ExternalID": "1605756488530014",
                "SubmitOptions": ["C"]  
            }
        ]
    }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023010901154861C57537B04A4A16B7C1",
        "Action": "ListQuizRecordAPI",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "Error": {
            "Code": "InvalidParameter.ActivityIdNotFound",
            "Message": "The specified parameter ActivityId is invalid."
        },
        "SystemTime": 1673198148
    },
    "Result": null
}

错误码

下表提供了该接口特有的错误码,公共错误码请参见公共错误码文档。

状态码错误码错误信息说明
400InvalidParameter.ActivityIdInvalidThe specified parameter ActivityId is invalid.直播间 ID 不符合规范,请修改后重试
500InternalErrorThe request has failed due to an unknown error.请求处理过程中出现了未知错误,请联系技术支持获取帮助