查询频道虚拟人数设置

接口描述

1、查询频道的虚拟人数设置
2、接口支持https协议

接口URL

http://api.polyv.net/live/v4/channel/robot/setting/get

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

频道号

示例

http://api.polyv.net/live/v4/channel/robot/setting/get?appId=frlr1zazn3&sign=ACD429EFC4656840A64039FF2CF79776&channelId=3335806&timestamp=1662688925470

响应参数描述

参数名类型说明

code

Integer

状态码,与 http 状态码相同,用于确定基本的响应状态

status

String

响应结果,由业务决定,成功返回success,失败返回error

success

Boolean

是否成功响应

requestId

String

请求ID,每次请求生成的唯一的 UUID,仅可用于排查、调试,不应该和业务挂上钩

error

Object

状态码非200时的错误信息【详见Error字段描述

data

Object

【详见data字段说明

Error参数描述

参数名类型说明

code

Integer

错误代码,用于确定具体的错误原因

desc

String

错误描述,与 error.code 对应

data参数描述

参数名类型说明

channelId

Integer

频道号

robotNumber

Integer

聊天室显示虚拟人数

addRobotModel

String

人数显示模式 timely:立即生效 fixed_time:分时生效

virtualBookingNumber

Integer

虚拟预约人数

changeTime

Integer

生效时间,单位毫秒

leftTime

Long

距离下次可设置时间,单位毫秒

Java请求示例

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

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

private static final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 查询频道虚拟人数设置
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void getRobotSettingTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "http://api.polyv.net/live/v4/channel/robot/setting/get";
    String channelId = "3335806";
    
    //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",
    "requestId": "61b9319c9e3b42979f8a152dfa6b3f40.71.16626889287143865",
    "data": {
        "channelId": 3335806,
        "robotNumber": 100,
        "addRobotModel": "fixed_time",
        "virtualBookingNumber": 30,
        "changeTime": 20000,
        "leftTime": 0
    },
    "success": true
}

异常示例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}

Last updated