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

文档中心

立即注册

导航

企业直播

获取问卷数据信息

最近更新时间：2024.09.04 17:24:26首次发布时间：2022.03.29 22:10:12

您可通过此接口获取指定直播间的问卷答卷信息，只能查询 10000 条以内。

说明

该接口已经不再维护，建议调用 ListQuestionnaireAnswerDataAPIV2 接口获取问卷答卷信息。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	描述
Action	String	是	接口名称
Version	String	是	接口版本。直播当前 API 的版本为 2020-06-01
ActivityId	Int64	是	直播间 ID。您可通过ListActivityAPI 接口查询 ID
QuestionnaireId	Int64	是	问卷 ID
PageNo	Int	是	分页查询页码
PageItemCount	Int	是	分页查询数量
Source	Int32	是	根据页面访问来源进行筛选。支持以下六种取值。 -1：查询所有； 0：查询默认来源； 1：查询来源 A； 2：查询来源 B； 3：查询来源 C； 4：查询来源 D。

返回参数

参数	类型	描述
PageItemCount	Int	分页查询数量
PageNo	Int	分页查询页码
TotalItemCount	Int	问卷数据总数
Questions	Array of Question	问卷问题
Questionnaires	Array of Questionnaire	问卷数据

Question

参数	类型	描述
QuestionId	Int	问题顺序
Question	String	问题描述
IsRequire	Int	是否必填。支持以下两种取值。 0: 非必填； 1: 必填。
QuestionTag	String	问题类型。支持以下三种取值。 blank_filling: 填空题； personal_info: 个人信息； select: 选择题。
QuestionSubTag	String	问题子类型。支持以下六种取值。 phone_number: 手机号码； email: email； nickname: 昵称； text: 填空题； radio: 单选题； checkbox: 多选题。
Options	Array of Option	问题选项

Option

参数	类型	描述
OptionId	Int	选项排序
OptionName	String	选项内容

Questionnaire

参数	类型	描述
QuestionAnswers	Array of QuestionAnswer	问题答案列表
SendTime	Int64	填写问卷时间
UserInfo	Array of UserInfo	用户信息

QuestionAnswer

参数	类型	描述
QuestionId	Int	问题 ID
Question	String	问题描述
Answer	String	问题答案

UserInfo

参数	类型	描述
UserId	String	用户 ID
NickName	String	用户昵称
Extra	String	业务方扩展参数
Telephone	String	手机号
Email	String	Email
Country	String	国家
Province	String	省份

示例

请求示例

Get http://livesaas.volcengineapi.com/?Action=ListQuestionnaireAnswerDataAPI&Version=2020-06-01&ActivityId=1231231231&Source=0&QuestionnaireId=123&PageNo=1&PageItemCount=10

正常返回示例

{
		"ResponseMetadata":{
				"RequestId":"202201201826170101501312091D1C09D2",
				"Action":"ListQuestionnaireAnswerDataAPI",
				"Version":"2020-06-01",
				"Service":"livesaas",
				"Region":"cn-north-1",
				"SystemTime":1656067132
		},
		"Result":{
				"PageItemCount":1,
				"PageNo":1,
				"TotalItemCount":1,
				"Questions":[
						{
								"QuestionId":1,	
								"Question":"a"	,	
								"IsRequire":1,	
								"QuestionTag":"blank_filling",	
								"QuestionSubTag":"text",
								"Options":[]
						}
				],
				"Questionnaires":[
						{
								"QuestionAnswers":[
										{
												"QuestionId":1,	
												"Question":"abc",	
												"Answer":"bva"	
										}
								],
								"SendTime":1111,
								"UserInfo":{
										"UserId":"12",
										"NickName":"abv"	
										"Extra":""
										"Telephone":""
										"Email":""
										"Country":""
										"Province":""
								}
						}
				]
		}
}

异常返回示例

{
     "ResponseMetadata":{
         "RequestId":"201806041104200100100232280022D30",
         "Action":"ListQuestionnaireAnswerDataAPI",
         "Version":"2020-06-01",
         "Service":"livesaas",
         "Region":"cn-north-1",
         "SystemTime":1656067132,
         "Error":{
             "Code":"200000",
             "Message":"参数异常" 
         }
    }
}

错误码

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