Modify Channel Password

Updated: 2022-12-12 11:51:12

API Description

1、修改单个频道号的密码，或者修改账号下所有频道号的密码
2、接口URL中的{userId}为直播账号ID
3、接口支持https协议

API URL

http://api.polyv.net/live/v2/channels/{userId}/passwdSetting

Online API Call

Request Method

POST

API Constraints

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

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details: Get Secret Key
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 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 retrieve response data.` See details: Signature Generation Rules
passwd	true	String	The password to be modified
channelId	false	String	Channel ID. If this parameter is empty, the password will be modified for all channels of the user.

Example

http://api.polyv.net/live/v2/channels/1b448be323/passwdSetting

Form Parameters:

passwd=Ypul5tU6WuT0mr7N&appId=frlr1zazn3&sign=46CACF26B12D98A229F85441EB487019&channelId=2191532&timestamp=1621840423556

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code. 200 indicates success, non-200 indicates failure. See details: 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 true 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. The test case files HttpUtil.java and LiveSignUtil.java are included in the download package.

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(ChannelOperateTest.class);
/**
 * 修改频道密码
 * @throws IOException
 */
@Test
public void testUpdatePassword() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String channelId = "2191532";
    String temp = String.format("http://api.polyv.net/live/v2/channels/%s/passwdSetting", userId);
    String passwd = getRandomString(8);
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    
    requestMap.put("channelId", channelId);
    requestMap.put("passwd", passwd);
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(temp, requestMap);
    log.info("测试修改频道密码接口返回值：{}", response);
    //do somethings
    
}

Response Example

For system-wide global error descriptions, see Global Error Description

Success Example

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

Error Example

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