获取直播间问卷数据信息--企业直播-火山引擎

文档中心

立即注册

导航

获取直播间问卷数据信息

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

您可通过此接口获取指定直播间的问卷数据信息。最多支持查询 10,000 条数据。

注意事项

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

请求说明

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

请求参数

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

Query

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

返回参数

参数	类型	示例值	描述
PageItemCount	Integer	`10`	分页查询数量。
PageNo	Integer	`1`	分页查询页码。
TotalItemCount	Integer	`1`	问卷总数。
Questions	Array of Questions	`-`	问卷问题列表。
Questionnaires	Array of Questionnaires	`-`	问卷数据列表。

Questions

参数	类型	示例值	描述
QuestionId	Integer	`186369`	问题 ID。
Question	String	`问题内容`	问题内容。
IsRequire	Integer	`1`	是否必填。支持以下取值： `0`：非必填 `1`：必填
QuestionTag	String	`select`	问题类型。支持以下取值 `blank_filling`：填空题 `personal_info`：个人信息 `select`：选择题
QuestionSubTag	String	`radio`	问题子类型。支持以下取值： `phone_number`：手机号码 `email`：邮箱 `nickname`：昵称 `text`：填空题 `radio`：单选题 `checkbox`：多选题
Options	Array of Options	`-`	问题选项信息。

Questionnaires

参数	类型	示例值	描述
QuestionAnswers	Array of QuestionAnswers	`-`	观众填写的问卷答案。
SendTime	Long	`1697092201`	观众填写问卷的时间。
UserInfo	Array of UserInfo	`-`	观众信息。

Options

参数	类型	示例值	描述
OptionId	Integer	`2`	选项排序。
OptionName	String	`选项2`	选项内容。

QuestionAnswers

参数	类型	示例值	描述
QuestionId	Integer	`186369`	问题 ID。
Question	String	`问题内容`	问题内容。
Answer	String	`选项1`	问题答案。

UserInfo

参数	类型	示例值	描述
UserId	String	`1744663139363934`	用户 ID，即观众在企业直播的唯一标识。
NickName	String	`观众 A`	用户昵称。
Extra	String	`abc`	业务方扩展字段。
Telephone	String	`182****5709`	手机号。
Email	String	`zhibo@example.com`	邮箱。
Country	String	`中国`	国家。
Province	String	`北京`	省份。
ExternalId	String	`31210506554471`	观众在第三方平台的唯一标识。您可以根据该关联用户 ID 识别企业自身的用户身份，以便于按需实现用户洞察和进行数据分析。观众通过不同方式登录直播间时，关联用户 ID 取值不同，具体取值情况详见数据统计。

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023101214312942F594DF74DDC3349741",
        "Action": "ListQuestionnaireAnswerDataAPIV2",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697092289
    },
    "Result": {
        "TotalItemCount": 1,
        "PageNo": 1,
        "PageItemCount": 10,
        "Questions": [
            {
                "QuestionId": 186369,
                "Question": "问题内容",
                "IsRequire": 1,
                "QuestionTag": "select",
                "QuestionSubTag": "radio",
                "Options": [
                    {
                        "OptionId": 1,
                        "OptionName": "选项1"
                    },
                    {
                        "OptionId": 2,
                        "OptionName": "选项2"
                    }
                ]
            }
        ],
        "Questionnaires": [
            {
                "QuestionAnswers": [
                    {
                        "QuestionId": 186369,
                        "Question": "问题内容",
                        "Answer": "选项1"
                    }
                ],
                "SendTime": 1697092201,
                "UserInfo": {
                    "UserId": "1744663139363934",
                    "NickName": "观众 A",
                    "Extra": "abc",
                    "Telephone": "182****5709",
                    "Email": "zhibo@example.com",
                    "Country": "中国",
                    "Province": "北京",
                    "ExternalId": "31210506554471"
                }
            }
        ]
    }
}

错误码

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