Query Application Role List

Updated: 2025-07-17 14:55:09

API Description

1、查询应用角色列表
2、接口支持https协议

API URL

http://api.polyv.net/live/v4/user/webapp-role/list

Online API Call

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for 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
timestamp	true	Long	Current 13-digit millisecond timestamp, valid within 3 minutes
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 stored or used directly on the client. All APIs must be called through the customer's own server to relay requests to the POLYV server for response data.` See signature generation rules
pageNumber	false	Integer	Current page number, defaults to 1
pageSize	false	Integer	Page size, defaults to 10

Example

http://api.polyv.net/live/v4/user/webapp-role/list?pageNumber=1&appId=frlr1zazn3&sign=76AEC105CAD0C5091FCECCF14FC6DA74&pageSize=10&timestamp=1699580616354

Response Parameter Description

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

Error Parameter Description

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

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	Role ID
name	String	Role name
userId	String	User ID
description	String	Role description
status	Boolean	Role status
createdTime	Long	Creation timestamp
lastModified	Long	Last modification timestamp
permissionName	String	Permission name
isOldRole	Boolean	Whether it is an old role
type	String	Role type (root: visible only to the primary account, child: visible to both primary and sub-accounts)

Java Request Example

For quick integration of 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 in the downloaded file.

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

private static final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 查询应用角色列表
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void getRoleListTest() 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/user/webapp-role/list";
    String pageNumber = "1";
    String pageSize = "10";
    
    //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": "bf2ffb7b-b062-4e6b-ba70-94b5495c2591",
    "data": {
        "pageNumber": 1,
        "pageSize": 10,
        "totalPages": 1,
        "totalItems": 7,
        "contents": [
            {
                "id": 3519,
                "name": "123222",
                "userId": "2b3ccac944",
                "description": "",
                "status": true,
                "createdTime": 1752720853000,
                "lastModified": 1752720858000,
                "permissionName": "新建直播",
                "isOldRole": false,
                "type": "root"
            },
            {
                "id": 3518,
                "name": "测试",
                "userId": "2b3ccac944",
                "description": "123123",
                "status": true,
                "createdTime": 1752720399000,
                "lastModified": 1752720399000,
                "permissionName": "新建直播",
                "isOldRole": false,
                "type": "root"
            }
        ]
    },
    "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