查询频道问卷列表

接口描述

1、获取频道的问卷列表
2、接口支持https协议

接口URL

http://api.polyv.net/live/v3/channel/questionnaire/list

在线API调用

请求方式

GET

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】
channelId	true	String	频道号
startTime	false	Long	查询的记录的开始时间，13位毫秒级时间戳
endTime	false	Long	查询的记录的结束时间，13位毫秒级时间戳
page	false	Integer	页号，默认为1
pageSize	false	Integer	每页条数，默认为10

示例

https://api.polyv.net/live/v3/channel/questionnaire/list?appId=frlr1zazn3&sign=21914C8E80403BF527F6061DD79DAE47&channelId=1965681&timestamp=1621843841035

响应参数描述

参数名	类型	说明
code	Integer	响应状态码，200为成功返回，非200为失败【详见全局错误说明】
status	String	响应状态文本信息
message	String	响应描述信息，当code为400或者500的时候，辅助描述错误原因
data	Object	成功响应时为问卷基本信息 【详见data字段说明】

data字段说明

参数名	类型	说明
pageSize	Integer	总页数
pageNumber	Integer	当前的页数
totalItems	Integer	总的条数
contents	Array	查询的结果列表 【详见contents字段说明】
firstPage	Boolean	是否为第一页，值为：true/false
lastPage	Boolean	是否为最后一页，值为：true/false
nextPageNumber	Integer	下一页编号
prePageNumber	Integer	上一页编号
totalPages	Integer	总页数
startRow	Integer	当前页第一条记录在总结果集中的位置
endRow	Integer	当前页最后一条记录在总结果集中的位置
limit	Integer	当前页视频个数
offset	Integer	分页起始记录

contents字段说明

参数名	类型	说明
questionnaireId	String	问卷ID
channelId	String	频道号
userId	String	用户ID
name	String	问题题目
name	String	问题题目
type	String	问卷类型 survey：问卷调研 exam：随堂测试
status	String	问卷状态 saved：已保存 published：已发布 forbidden：已禁用
createdTime	Long	创建时间，13位毫秒级时间戳
lastModified	Long	问卷最后修改时间，13位毫秒级时间戳
endTime	Long	停止提交问卷时间，13位毫秒级时间戳
customQuestionnaireId	String	用户自定义问卷ID

Java请求示例

快速接入基础代码请下载相关依赖源码， 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。

强烈建议您使用直播Java SDK完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

private static final Logger log = LoggerFactory.getLogger(LiveInteractionTest.class);

/**
 * 查询频道问卷列表
 * @throws IOException
 */
@Test
public void testListQuestionaire() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId=super.appId;
    String appSecret=super.appSecret;
    String userId = super.userId;
    String timestamp=String.valueOf(System.currentTimeMillis());
    //业务参数
    String channelId = "1965681";
    String questionnaireId = "fwndt7vq4x";
    String url = "http://api.polyv.net/live/v3/channel/questionnaire/list";

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("channelId",channelId);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url,requestMap);
    log.info("测试查询频道问卷列表接口返回值：{}",response);
    //do somethings
}

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
	"code": 200,
	"status": "success",
	"message": "",
	"data": {
		"pageSize": 10,
		"pageNumber": 1,
		"totalItems": 1180,
		"contents": [{
			"questionnaireId": "fwnf2sbpf5",
			"channelId": 1965681,
			"userId": "1b448be323",
			"name": "问卷标题啊啊啊啊啊啊啊啊",
			"status": "saved",
			"createdTime": 1615510062000,
			"lastModified": 1615515862000,
			"endTime": null,
			"customQuestionnaireId": "6a3ff44289f94a5fb1dd8341ac1c0100"
		}, {
			"questionnaireId": "fwndt7vq4x",
			"channelId": 1965681,
			"userId": "1b448be323",
			"name": "测试试卷，明天会更好调查2 (1175)",
			"status": "saved",
			"createdTime": 1615507307000,
			"lastModified": 1615507307000,
			"endTime": null,
			"customQuestionnaireId": "30231311ed334a7f80e4db520b3bec99"
		}, {
			"questionnaireId": "fwndsuurwg",
			"channelId": 1965681,
			"userId": "1b448be323",
			"name": "测试试卷，明天会更好调查2 (1174)",
			"status": "saved",
			"createdTime": 1615507286000,
			"lastModified": 1615507286000,
			"endTime": null,
			"customQuestionnaireId": "c73351a8ea524b889d9034e2ad9783aa"
		}, {
			"questionnaireId": "fwmqno940c",
			"channelId": 1965681,
			"userId": "1b448be323",
			"name": "测试试卷，明天会更好调查2 (1173)",
			"status": "saved",
			"createdTime": 1615456906000,
			"lastModified": 1615456906000,
			"endTime": null,
			"customQuestionnaireId": "f7ca11536c424756a0e80c74536b31db"
		}, {
			"questionnaireId": "fwmqnbvbse",
			"channelId": 1965681,
			"userId": "1b448be323",
			"name": "测试试卷，明天会更好调查2 (1172)",
			"status": "saved",
			"createdTime": 1615456885000,
			"lastModified": 1615456885000,
			"endTime": null,
			"customQuestionnaireId": "9c0ad9042085449d99a08dfa435a33d3"
		}, {
			"questionnaireId": "fwmgqghdop",
			"channelId": 1965681,
			"userId": "1b448be323",
			"name": "测试试卷，明天会更好调查2 (1171)",
			"status": "saved",
			"createdTime": 1615435307000,
			"lastModified": 1615435307000,
			"endTime": null,
			"customQuestionnaireId": "b52d64b0ff7541a898baf3ee58a0ddb7"
		}, {
			"questionnaireId": "fwmgq40os8",
			"channelId": 1965681,
			"userId": "1b448be323",
			"name": "测试试卷，明天会更好调查2 (1170)",
			"status": "saved",
			"createdTime": 1615435286000,
			"lastModified": 1615435286000,
			"endTime": null,
			"customQuestionnaireId": "1b76b6d7d6d841c3b859ad40b81b69f8"
		}, {
			"questionnaireId": "fwmbdvg8vq",
			"channelId": 1965681,
			"userId": "1b448be323",
			"name": "测试试卷，明天会更好调查2 (1169)",
			"status": "saved",
			"createdTime": 1615423662000,
			"lastModified": 1615423662000,
			"endTime": null,
			"customQuestionnaireId": "9fd4d52c684645529859d1941a56bdea"
		}, {
			"questionnaireId": "fwma472twi",
			"channelId": 1965681,
			"userId": "1b448be323",
			"name": "测试试卷，明天会更好调查2 (1168)",
			"status": "saved",
			"createdTime": 1615420900000,
			"lastModified": 1615420900000,
			"endTime": null,
			"customQuestionnaireId": "ac9598b8492e4a3b81a8eab8ba81f678"
		}, {
			"questionnaireId": "fwma3v7hjn",
			"channelId": 1965681,
			"userId": "1b448be323",
			"name": "测试试卷，明天会更好调查2 (1167)",
			"status": "saved",
			"createdTime": 1615420880000,
			"lastModified": 1615420880000,
			"endTime": null,
			"customQuestionnaireId": "04be6a81d35f4c78a90d7d0f80ea6655"
		}],
		"startRow": 1,
		"firstPage": true,
		"lastPage": false,
		"prePageNumber": 1,
		"limit": 10,
		"totalPages": 118,
		"nextPageNumber": 2,
		"endRow": 10,
		"offset": 0
	}
}

异常示例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}