Paginated Query for Robot Virtual Nicknames

Updated: 2023-03-17 11:53:21

Interface Description

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

Interface URL

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

Online API Call

Request Method

GET

Interface Constraints

The interface supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. API calls have frequency limits. See details

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details on obtaining keys
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret key used to generate the signature is critical for communication data security. It must not be used directly on the client side. All APIs must be called through your own server to relay requests to the POLYV server for response data.` See signature generation rules
timestamp	true	String	Current 13-digit millisecond timestamp, valid for 3 minutes
pageNumber	false	String	Current page number
pageSize	false	String	Page size

Example

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

Response Parameter Description

Parameter	Type	Description
code	Integer	Status code, same as HTTP status code, used to determine the basic response status
data	Object	See Data parameter description
error	Object	Error information when status code is not 200 See Error parameter description
requestId	String	Request ID, a unique UUID generated for each request, only used for troubleshooting and debugging, not related to business logic
status	String	Response result, determined by business logic. Returns success on success, error on failure
success	Boolean	Whether the response was successful

Data Parameter Description

Parameter	Type	Description
contents	Array	Paginated data collection See Contents parameter description
pageNumber	Integer	Current page number
pageSize	Integer	Page size
totalItems	Integer	Total number of records
totalPages	Integer	Total number of pages

Contents Parameter Description

Parameter	Type	Description
id	Integer	Robot information ID
avatar	String	Robot information avatar
lastModified	String	Robot information modification time
name	String	Robot information nickname

Error Parameter Description

Parameter	Type	Description
code	Integer	Error code, used to determine the specific error cause
desc	String	Error description, corresponding to error.code

Java Request Example

For quick integration of the basic code, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source project. The test cases include HttpUtil.java and LiveSignUtil.java, both contained in the downloaded file.

It is strongly recommended to use the Live Java SDK for API functionality integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

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

}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "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
}

Error Example

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

Live Streaming Server API