Update Application Role Information

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

API Description

1、更新应用角色信息
2、接口支持https协议

API URL

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

Online API Call

Request Method

POST

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 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 not be stored or used directly on the client side. 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
roleId	true	Integer	Role ID
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	false	Array	List of permission IDs, e.g., [1,2,3]

Example

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

Request Body:

{
    "roleId": 1,
    "name": "更新后的角色名称",
    "desc": "更新后的角色描述",
    "roleType": "root",
    "permissionIds": [1, 2, 3]
}

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 response was successful
requestId	String	Request ID, a unique UUID generated for each request. Only used for troubleshooting and debugging, not to be tied to 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 reason
desc	String	Error description, corresponding to error.code

Java Request Example

For quick integration of the base 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 updateRoleTest() 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/update";
    
    //请求体参数
    Map<String, Object> requestBodyMap = new HashMap<>();
    requestBodyMap.put("roleId", 1);
    requestBodyMap.put("name", "更新后的角色名称");
    requestBodyMap.put("desc", "更新后的角色描述");
    requestBodyMap.put("roleType", "root");
    requestBodyMap.put("permissionIds", Arrays.asList(1, 2, 3));
    
    //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