您可通过此接口获取直播间内指定答题或简答的观众参与名单。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ListQuizRecordAPI | 接口名称。当前 API 的名称为 ListQuizRecordAPI。 |
| Version | String | 是 | 2020-06-01 | 接口版本。当前 API 的版本为 2020-06-01。 |
ActivityId | Long | 是 |
| 直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。 说明 使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。 |
| PageNo | Integer | 否 | 1 | 分页查询页码，默认值为 1。 |
| PageItemCount | Integer | 否 | 10 | 分页查询数量，默认值为 10。 |
| QuizID | Integer | 是 | 177951****345672 | 答题或简答 ID。您可通过调用 ListQuizStatisticsAPI 接口获取 ID。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| PageNo | Integer | 1 | 分页查询页码。 |
| PageItemCount | Integer | 10 | 分页查询数量。 |
| PageTotalCount | Integer | 1 | 查询结果总数。 |
| QuizStatisticsList | Array of QuizStatisticsList | - | 答题或简答参与名单列表。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| UserID | Long | 173868****584142 | 用户 ID，即观众在企业直播的唯一标识。 |
| UserName | String | 观众 A | 观众昵称。 |
| UserTel | String | 152*****365 | 观众手机号。 |
| String | ***@example.com | 观众邮箱。 | |
| CreateTime | Integer | 1673348952 | 观众提交答案的时间。Unix 时间戳，单位为秒。 |
IsRight | Boolean |
| 观众作答是否正确。取值如下：
|
| Extra | String | abc | 业务方扩展参数。 |
| UserAgent | String | Intel Mac OS X 10_15_7 | 观众的终端机型。 |
| Ip | String | 10.255.255.157 | 观众的 IP 地址。 |
| ExternalId | String | 160575****530014 | 观众在第三方平台的唯一标识。您可以根据该关联用户 ID 识别企业自身的用户身份，以便于按需实现用户洞察和进行数据分析。观众通过不同方式登录直播间时，关联用户 ID 取值不同，具体取值情况详见数据统计 |
| SubmitOptions | Array of String | ["A","C"] | 观众提交的答案。 |
GET https://livesaas.volcengineapi.com/?Action=ListQuizRecordAPI&Version=2020-06-01&ActivityId=1779****8715&PageNo=1&PageItemCount=10&QuizID=177951****345672
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "ListQuizRecordAPI", "Version": "2020-06-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1697446406 }, "Result": { "PageNo": 1, "PageItemCount": 10, "PageTotalCount": 1, "QuizStatisticsList": [ { "UserID": 173868****584142, "UserName": "观众 A", "UserTel": "152*****365", "Email": "***@example.com", "CreateTime": 1673348952, "IsRight": false, "Extra": "abc", "UserAgent": "Intel Mac OS X 10_15_7", "Ip": "10.255.255.157", "ExternalId": "160575****530014", "SubmitOptions": [ "A", "C" ] } ] } }