查询频道问卷题目与结果

接口描述

1、查询频道问卷题目与结果
2、问卷ID可以从获取频道问卷列表中获取
3、接口支持https协议

接口URL

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

在线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

频道号

questionnaireId

true

String

问卷id,该参数获取自【查询频道问卷列表

示例

https://api.polyv.net/live/v3/channel/questionnaire/detail?appId=frlr1zazn3&sign=21B0DC009E318AA78636A7CE9C622056&questionnaireId=fwndt7vq4x&channelId=1965681&timestamp=1621845043008

响应参数描述

参数名类型说明

code

Integer

响应状态码,200为成功返回,非200为失败【详见全局错误说明

status

String

响应状态文本信息

message

String

响应描述信息,当code为400或者500的时候,辅助描述错误原因

data

Object

成功响应时为问卷基本信息 【详见data字段说明

data字段说明

参数名类型说明

questionnaireId

String

问卷ID

customQuestionnaireId

String

用户自定义问卷ID

channelId

String

频道号

userId

String

用户ID

name

String

问卷名称

status

String

问卷状态 draft:草稿 send:已发送 delete:已删除

createdTime

Long

问卷创建时间

endTime

Long

停止问卷时间

questions

Array

问卷问题列表 【详见questions字段说明

questions字段说明

参数名类型说明

questionId

String

问题ID

channelId

String

频道号

userId

String

用户ID

name

String

问题题目

type

String

问题类型 R:单选 C:多选 S:评星题 Q:问答

option 1~10

String

选项A~J的内容

createdTime

String

创建时间

lastModified

String

最后修改时间

answer

String

问题答案

note

String

备注

templateId

String

模板Id

status

String

问卷状态 draft:草稿 send:已发送 delete:已删除

times

Integer

问卷发起次数

tips1 1~5

String

题目对应的提示

required

String

是否必填 Y:必填 N:非必填

scoreEnabled

String

是否计分 Y:计分 N:不计分

score

String

题目分值

itemType

Integer

答题类型 1:问答 0:答题卡

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 testGetQuestionnaireDetail() 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/detail";

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);

    requestMap.put("channelId",channelId);
    requestMap.put("questionnaireId",questionnaireId);

    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url,requestMap);
    log.info("测试查询频道问卷题目与结果接口返回值:{}",response);
    //do somethings
}

响应示例

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

成功示例

{
	"code": 200,
	"status": "success",
	"message": "",
	"data": {
		"questionnaireId": "fwndt7vq4x",
		"channelId": 1965681,
		"userId": "1b448be323",
		"name": "测试试卷,明天会更好调查2 (1175)",
		"status": "saved",
		"createdTime": 1615507307000,
		"lastModified": 1615507307000,
		"endTime": null,
		"customQuestionnaireId": "30231311ed334a7f80e4db520b3bec99",
		"questions": [{
			"questionId": "4bb657cc5897451ea4705a9bb843e16c",
			"channelId": 1965681,
			"userId": "1b448be323",
			"name": "您的兴趣爱好?",
			"type": "C",
			"option1": "篮球",
			"option2": "足球",
			"option3": "排球",
			"option4": "跑步",
			"option5": "羽毛球",
			"createdTime": 1615507307000,
			"lastModified": 1615507307000,
			"answer": "a",
			"note": null,
			"templateId": null,
			"status": "draft",
			"times": 0,
			"tips1": null,
			"tips2": null,
			"tips3": null,
			"tips4": null,
			"tips5": null,
			"required": "Y",
			"scoreEnabled": "Y",
			"option6": null,
			"option7": null,
			"option8": null,
			"option9": null,
			"option10": null,
			"score": 20,
			"itemType": 0,
			"option11": null,
			"option12": null,
			"option13": null,
			"option14": null,
			"option15": null
		}, {
			"questionId": "b5b33c428cfd488eb8f4c5991e4e9aff",
			"channelId": 1965681,
			"userId": "1b448be323",
			"name": "您的性别",
			"type": "R",
			"option1": "M",
			"option2": "W",
			"option3": null,
			"option4": null,
			"option5": null,
			"createdTime": 1615507307000,
			"lastModified": 1615507307000,
			"answer": "",
			"note": null,
			"templateId": null,
			"status": "draft",
			"times": 0,
			"tips1": null,
			"tips2": null,
			"tips3": null,
			"tips4": null,
			"tips5": null,
			"required": "Y",
			"scoreEnabled": "N",
			"option6": null,
			"option7": null,
			"option8": null,
			"option9": null,
			"option10": null,
			"score": null,
			"itemType": 0,
			"option11": null,
			"option12": null,
			"option13": null,
			"option14": null,
			"option15": null
		}, {
			"questionId": "cc4b8c4c44d346bcab4bb47e3dca275d",
			"channelId": 1965681,
			"userId": "1b448be323",
			"name": "您的职务?",
			"type": "Q",
			"option1": "",
			"option2": null,
			"option3": null,
			"option4": null,
			"option5": null,
			"createdTime": 1615507307000,
			"lastModified": 1615507307000,
			"answer": "",
			"note": null,
			"templateId": null,
			"status": "draft",
			"times": 0,
			"tips1": null,
			"tips2": null,
			"tips3": null,
			"tips4": null,
			"tips5": null,
			"required": "Y",
			"scoreEnabled": "N",
			"option6": null,
			"option7": null,
			"option8": null,
			"option9": null,
			"option10": null,
			"score": null,
			"itemType": 0,
			"option11": null,
			"option12": null,
			"option13": null,
			"option14": null,
			"option15": null
		}]
	}
}

异常示例

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

Last updated