查询频道提问记录

接口描述

1、通过频道号,查询咨询提问记录
2、接口支持https协议
3、接口URL中的{channelId}为"频道号"

接口URL

http://api.polyv.net/live/v2/chat/{channelId}/getQuestion

在线API调用

请求方式

GET

接口约束

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

请求参数描述

参数名必选类型说明

appId

true

String

账号appId【详见获取密钥

timestamp

true

Long

当前13位毫秒级时间戳,3分钟内有效

sign

true

String

签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则

begin

false

Integer

起始下标,从0开始

end

false

Integer

结束下标,-1表示不分页

示例

http://api.polyv.net/live/v2/chat/2191569/getQuestion?appId=frlr1zazn3&sign=40763580D3C4C34CF268018E154944D3&end=1&begin=0&timestamp=1616636714152

响应参数描述

参数名类型说明

code

Integer

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

status

String

响应状态文本信息

message

String

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

data

Array

提问记录的列表数据 【详见data字段说明

data字段说明

参数名类型说明

id

String

信息id

content

String

内容

time

Long

时间,13位时间戳

s_userId

String

提问者id

event

String

消息类型 T_ANSWER:讲师回答 S_QUESTION:学生提问

sourceType

String

观众来源

user

Object

发言人信息 【详见user字段说明

user字段说明

参数名类型说明

nick

String

发言人昵称

pic

String

发言人头像

userId

String

发言人id

sessionId

String

场次号

userType

String

发言人类型值

banned

Boolean

是否禁言(true/false)

channelId

String

频道号

Java请求示例

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

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

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

/**
 * 查询频道提问记录
 * @throws IOException
 */
@Test
public void testGetQuestionList() throws IOException, NoSuchAlgorithmException {
        //公共参数,填写自己的实际参数
        String appId = super.appId;
        String appSecret = super.appSecret;
        String timestamp = String.valueOf(System.currentTimeMillis());

        //业务参数
        String channelId = "2191569";
        String url = "http://api.polyv.net/live/v2/chat/"+channelId+"/getQuestion";
        Integer begin = 0;
        Integer end = 1;

        //http 调用逻辑
        Map<String,String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp",timestamp);
        requestMap.put("begin",begin.toString());
        requestMap.put("end",end.toString());
        requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
        String response = HttpUtil.get(url, requestMap);
        log.info("测试查询频道提问记录接口返回值:{}",response);

}

响应示例

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

成功示例

{
  "code": 200,
  "status": "success",
  "message": "",
  "data": [
    {
      "id": "ef523640-855c-11eb-ac86-91e249016089",
      "user": {
        "nick": "卉",
        "pic": "https://thirdwx.qlogo.cn/mmopen/vi_32/3lMXVJoLMLJibnkFuA23lyqj5MOQufhW5ATvHuB8byssutficHKU0u7OMx5OQgg9WNVuHf44AXfbAMMAZejuYFTg/132",
        "userId": "ovtl9t_RxnrTdqkXqkT5Q5lnxp2A",
        "sessionId": null,
        "userType": "student",
        "banned": false,
        "channelId": null
      },
      "content": "很长的提问",
      "time": 1615791976356,
      "s_userId": null,
      "event": "S_QUESTION",
      "sourceType": null
    },
    {
      "id": "e9090520-855c-11eb-ac86-91e249016089",
      "user": {
        "nick": "卉",
        "pic": "https://thirdwx.qlogo.cn/mmopen/vi_32/3lMXVJoLMLJibnkFuA23lyqj5MOQufhW5ATvHuB8byssutficHKU0u7OMx5OQgg9WNVuHf44AXfbAMMAZejuYFTg/132",
        "userId": "ovtl9t_RxnrTdqkXqkT5Q5lnxp2A",
        "sessionId": null,
        "userType": "student",
        "banned": false,
        "channelId": null
      },
      "content": "提问",
      "time": 1615791965810,
      "s_userId": null,
      "event": "S_QUESTION",
      "sourceType": null
    }
  ]
}

异常示例

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

Last updated