获取直播间问卷列表--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

获取直播间问卷列表

最近更新时间：2024.09.04 17:25:19首次发布时间：2023.02.01 10:13:29

您可通过此接口获取指定直播间的问卷列表。

注意事项

请求频率：单用户请求频率限制为 120 次/分钟。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListQuestionnaireDataAPIV2`	接口名称。当前 API 的名称为 `ListQuestionnaireDataAPIV2`。
Version	String	是	`2020-06-01`	接口版本。当前 API 的版本为 `2020-06-01`。
ActivityId	Long	是	`1779168245`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。
PageNo	Integer	否	`1`	分页查询页码。默认值为 `1`。
PageItemCount	Integer	否	`10`	分页查询数量。默认值为 `10`。
Channel	String	否	`123`	渠道标识。支持根据渠道标识查询不同渠道下的 `UserCount` （即问卷参与人数）。默认查询全部渠道数据。您可以通过 ListChannelAPI 接口查询渠道标识。

返回参数

参数	类型	示例值	描述
PageItemCount	Integer	`10`	分页查询数量。
PageNo	Integer	`1`	分页查询页码。
TotalItemCount	Integer	`1`	问卷总数。
StatisticsQuestionnaires	Array of StatisticsQuestionnaires	`-`	问卷信息。

StatisticsQuestionnaires

参数	类型	示例值	描述
QuestionnaireId	Integer	`117850`	问卷 ID。
Title	String	`问卷 A`	问卷标题。
PublishTime	Long	`1697091022`	问卷发布时间。Unix 时间戳，单位为秒。
UserCount	Integer	`11`	问卷参与人数。
IsDelete	Boolean	`false`	问卷是否已删除。支持以下取值： `false`：否 `true`：是

请求示例

GET https://livesaas.volcengineapi.com/?Action=ListQuestionnaireDataAPIV2&Version=2020-06-01&ActivityId=1779168245&PageNo=1&PageItemCount=10&Channel=123

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202201201826170101501312091D1C09D2",
    "Action": "ListQuestionnaireDataAPIV2",
    "Version": "2020-06-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1656067132
  },
  "Result": {
    "PageItemCount": 10,
    "PageNo": 1,
    "TotalItemCount": 1,
    "StatisticsQuestionnaires": [
      {
        "QuestionnaireId": 117850,
        "Title": "问卷 A",
        "PublishTime": 1697091022,
        "UserCount": 11,
        "IsDelete": false
      }
    ]
  }
}

错误码

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