Modify Role Information

Updated: 2023-03-29 14:41:14

API Description

1、修改助教或嘉宾的信息
2、接口URL中的{channelId}为频道号
3、接口支持https协议

API URL

http://api.polyv.net/live/v2/channelAccount/{channelId}/update

Request Method

POST

API Constraints

The API 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 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 saved 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 and obtain response data.` See Signature Generation Rules
account	true	String	Assistant/Guest account (must not be submitted as a numeric type, otherwise the leading '00' in the role number may be removed)
nickname	false	String	Role nickname
password	false	String	Role password
avatar	false	String	Role avatar URL, maximum 200 characters. Exceeding this will return a 400 error
actor	false	String	Role title
pageTurnEnabled	false	String	Role page turning permission. Only one role can have this. Only supported in tri-screen scenarios. Y: Enable N: Disable
notifyEnabled	false	String	Role announcement permission Y: Enable N: Disable

Example

http://api.polyv.net/live/v2/channelAccount/2191541/update

Form Parameters:

actor=%E5%8A%A9%E6%95%99&password=123456&pageTurnEnabled=Y&notifyEnabled=Y&appId=frlr1zazn3&nickname=%E9%99%88%E8%80%81%E5%B8%88&sign=08B5096C4EBA19C10750D4570004C9E1&avatar=https%3A%2F%2Fs1.videocc.net%2Fdefault-img%2Favatar%2Fassistant.png&account=0052191541&timestamp=1621841976967

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code. 200 indicates success, non-200 indicates failure See Global Error Description
status	String	Response status text
message	String	Response description. When code is 400 or 500, provides additional error details
data	String	Returns "success" on success, empty string on failure

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 code project. HttpUtil.java and LiveSignUtil.java from the test cases are included in the download file.

It is strongly recommended to use the Live Java SDK to implement API functionality. 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(ChannelOperateTest.class);
/**
 * 设置角色信息
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testUpdateAccount() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "https://api.polyv.net/live/v2/channelAccount/%s/update";
    String channelId = "2149710";
    String account = "0062149710";
    String nickname = "王老师";
    String password = getRandomString(10);
    String avatar = "https://s1.videocc.net/default-img/avatar/assistant.png";
    String actor = "助教";
    String pageTurnEnabled = "Y";
    String notifyEnabled = "Y";
    
    url = String.format(url, channelId);
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("account", account);
    requestMap.put("nickname", nickname);
    requestMap.put("password", password);
    requestMap.put("avatar", avatar);
    requestMap.put("actor", actor);
    requestMap.put("pageTurnEnabled", pageTurnEnabled);
    requestMap.put("notifyEnabled", notifyEnabled);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试设置角色信息，返回值：{}", response);
    //do somethings
    
}

Response Example

For system global error descriptions, see Global Error Description

Success Example

{
    "code":200,
    "status":"success",
    "message":"",
    "data":"success"
}

Error Example

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}

Live Streaming Server API