保利威文档中心

帮助中心

直播服务端 API

分页查询机器人虚拟昵称

更新时间：2023-03-17 11:53:21

接口描述

1、分页查询机器人虚拟昵称
2、接口支持https协议

接口URL

http://api.polyv.net/live/v4/global/robot/list

在线API调用

请求方式

GET

接口约束

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

请求参数描述

参数名 必选 类型 说明
appId true String 账号appId【详见获取密钥】
sign true String 签名，为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】
timestamp true String 当前13位毫秒级时间戳，3分钟内有效
pageNumber false String 当前页数，第几页
pageSize false String 分页大小

示例

http://api.polyv.net/live/v4/global/robot/list?pageNumber=1&appId=frlr1zazn3&sign=88A76BAB1B1F0701745954DF4D2ED256&pageSize=10&timestamp=1679021522304

响应参数描述

参数名 类型 说明
code Integer 状态码，与 http 状态码相同，用于确定基本的响应状态
data Object 【详见Data参数描述】
error Object 状态码非200时的错误信息【详见Error参数描述】
requestId String 请求ID，每次请求生成的唯一的 UUID，仅可用于排查、调试，不应该和业务挂上钩
status String 响应结果，由业务决定，成功返回success，失败返回error
success Boolean 是否成功响应

Data参数描述

参数名 类型 说明
contents Array 分页数据集合【详见Contents参数描述】
pageNumber Integer 当前页数，第几页
pageSize Integer 分页大小
totalItems Integer 总记录数
totalPages Integer 总页数

Contents参数描述

参数名 类型 说明
id Integer 机器人信息id
avatar String 机器人信息头像
lastModified String 机器人信息修改时间
name String 机器人信息昵称

Error参数描述

参数名 类型 说明
code Integer 错误代码，用于确定具体的错误原因
desc String 错误描述，与 error.code 对应

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 robotListTest() 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/global/robot/list";
    String pageNumber = "";
    String pageSize = "";

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

    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));

    String response = HttpUtil.get(url, requestMap);

    log.info("测试分页查询机器人虚拟昵称成功：{}", response);
    //do somethings

}

响应示例

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

成功示例

{
    "code": 200,
    "status": "success",
    "requestId": "99d7e672d04d42698d9c95fb70e7c9ab.68.16790215269634901",
    "data": {
        "pageNumber": 1,
        "pageSize": 10,
        "totalPages": 1,
        "totalItems": 2,
        "contents": [
            {
                "id": 127402,
                "name": "令狐冲",
                "avatar": "https://liveimages.videocc.net/defaultImg/avatar/viewer.png",
                "lastModified": 1619676728000
            },
            {
                "id": 814647,
                "name": "啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊啊1",
                "avatar": "https://liveimages.videocc.net/defaultImg/avatar/viewer.png",
                "lastModified": 1677225679000
            }
        ]
    },
    "success": true
}

异常示例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}
联系客服，在线咨询