Add Application Role

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

API Description

1、添加应用角色
2、接口支持https协议

API URL

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

Online API Call

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls are subject to rate limits. See details

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See Get Secret Key
timestamp	true	Long	Current 13-digit millisecond timestamp, valid for 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 never be stored or 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
name	true	String	Role name
desc	false	String	Role description
roleType	true	String	Role type (root: visible only to the primary account, child: visible to both primary and sub-accounts)
permissionIds	true	Array	List of permission IDs, e.g., [1,2,3]

Example

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

Request Body:

{
    "name": "测试角色",
    "desc": "这是一个测试角色",
    "roleType": "root",
    "permissionIds": [1, 2]
}

Response Parameter Description

Parameter	Type	Description
code	Integer	Status code, same as HTTP status code, used to determine the basic response status
status	String	Response result, determined by business logic. Returns success on success, error on failure
success	Boolean	Whether the request was successful
requestId	String	Request ID, a unique UUID generated for each request. 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	Returns an empty object on successful request

Error Parameter Description

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

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 code 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 pools.

private static final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 添加应用角色
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void addRoleTest() 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/create";
    
    //请求体参数
    Map<String, Object> requestBodyMap = new HashMap<>();
    requestBodyMap.put("name", "测试角色");
    requestBodyMap.put("desc", "这是一个测试角色");
    requestBodyMap.put("roleType", "root");
    requestBodyMap.put("permissionIds", Arrays.asList(1, 2));
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    String response = HttpUtil.postJson(url, requestMap, JacksonUtil.writeAsString(requestBodyMap));
    log.info("测试添加应用角色成功：{}", response);
    //do somethings
}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "3a05f8f5f6984232808d9e099f9ee938.3338.16995806199894399",
    "data": {},
    "success": true
}

Error Example

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "角色名称不能为空"
    },
    "success": false
}

Live Streaming Server API