分页获取问答的详细列表
更新时间:2022-09-02 18:08:07
接口URL
https://api.polyv.net/live/v3/channel/consultation/detail-list
接口说明
1、分页获取问答的详细列表
2、支持分页
3、接口支持https
支持格式
JSON
请求方式
GET
请求数限制
TRUE
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | 是 | string | 从API设置中获取,在直播系统登记的appId |
| timestamp | 是 | long | 当前13位毫秒级时间戳,3分钟内有效 |
| sign | 是 | String | 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
| channelId | 是 | int | 频道号 |
| sessionId | 否 | string | 场次ID |
| startTime | 否 | long | 查询的直播时间范围的开始时间 |
| endTime | 否 | long | 查询的直播时间范围的结束时间 |
| page | 否 | int | 当前页,默认1 |
| size | 否 | int | 每一页数据大小,默认10 |
响应成功JSON示例:
{
"code":200,
"status":"success",
"message":"",
"data":{
"pageSize":5,
"pageNumber":1,
"totalItems":23,
"contents":[
{
"askTime":"2021-03-15 14:36",
"nick":"啊啊啊啊",
"viewerId":"1615773668801",
"sessionId":"fwqzqpj6sf",
"content":"开导开导看",
"status":"未处理",
"reply":null
},
{
"askTime":"2021-03-15 14:36",
"nick":"啊啊啊啊",
"viewerId":"1615773668801",
"sessionId":"fwqzqpj6sf",
"content":"大大方方",
"status":"未处理",
"reply":null
},
{
"askTime":"2021-03-15 14:36",
"nick":"啊啊啊啊",
"viewerId":"1615773668801",
"sessionId":"fwqzqpj6sf",
"content":"少时诵诗书",
"status":"未处理",
"reply":null
},
{
"askTime":"2021-03-15 14:36",
"nick":"啊啊啊啊",
"viewerId":"1615773668801",
"sessionId":"fwqzqpj6sf",
"content":"1111111",
"status":"未处理",
"reply":null
},
{
"askTime":"2021-03-15 14:36",
"nick":"啊啊啊啊",
"viewerId":"1615773668801",
"sessionId":"fwqzqpj6sf",
"content":"2222222",
"status":"未处理",
"reply":null
}
],
"startRow":1,
"firstPage":true,
"lastPage":false,
"prePageNumber":1,
"limit":5,
"totalPages":5,
"nextPageNumber":2,
"endRow":5,
"offset":0
}
}
响应失败JSON示例:
未输入appId
{
"code": 400,
"status": "error",
"message": "appId is required.",
"data": ""
}
appId不正确
{
"code": 400,
"status": "error",
"message": "application not found.",
"data": ""
}
时间戳错误
{
"code": 400,
"status": "error",
"message": "invalid timestamp.",
"data": ""
}
签名错误
{
"code": 403,
"status": "error",
"message": "invalid signature.",
"data": ""
}
非法频道
{
"code": 403,
"status": "error",
"message": "illegal channel id: 1779742",
"data": ""
}
非法参数
{
"code": 400,
"status": "error",
"message": "param is not digit: size",
"data": ""
}
字段说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | int | 响应代码,成功为200,失败为400,签名错误为401,异常错误500 |
| status | string | 成功为success,失败为error |
| message | string | 错误时为错误提示消息 |
| data | object | 响应结果集 |
| pageNumber | int | 当前的页数 |
| totalItems | int | 总的条数 |
| contents | array | 查询的结果列表 |
| askTime | string | 提问的时间 |
| nick | string | 提问用户昵称 |
| viewerId | sting | 提问用户ID |
| sessionId | string | 所属的直播场次 |
| content | string | 提问的内容 |
| status | string | 问答的状态,比如:未处理 已回复等 |
| reply | string | 问题的答复内容 |
| firstPage | boolean | 是否为第一页,值为:true/false |
| lastPage | boolean | 是否为最后一页,值为:true/false |
| nextPageNumber | int | 下一页编号 |
| prePageNumber | int | 上一页编号 |
| totalPages | int | 总页数 |
| startRow | int | 当前页第一个数量的位置 |
| endRow | int | 当前页最后一个数量的位置 |
| limit | int | 每页数量大小 |
Java请求示例
public static void main(String[] args) {
String url = "https://api.polyv.net/live/v3/channel/consultation/detail-list";
// 用户对应的appId和加密串
String appId = "xxxxxxxxx";
String appSecret = "xxxxxxxxxxxxxxxxxxxxxxxxxx";
Map<String, String> params = new HashMap<>();
params.put("channelId", "0000000");
params.put("page", "1");
params.put("size", "10");
PolyvTool.setLiveSign(params, appId, appSecret);
// 调用Polyv的httpClient工具类发送请求
String content = HttpClientUtil.getInstance()
.sendHttpGet(url + "?" + PolyvTool.mapJoinNotEncode(params));
System.out.println(content);
}
