Modify Channel Host Name

Updated: 2022-09-02 18:08:07

API Description

1、设置单个或者所有频道的主持人姓名
2、接口URL中的{userId}为直播账号ID
3、接口支持https协议

API URL

http://api.polyv.net/live/v2/channelSetting/{userId}/setPublisher

Online API Call

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. API calls have frequency limits. Click for 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 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 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]
publisher	true	String	Host name, no more than 50 characters
channelId	false	String	Channel ID. If not submitted or set to -1, the host name will be modified for all channels under this user.

Example

http://api.polyv.net/live/v2/channelSetting/1b448be323/setPublisher

Form Parameters:

appId=frlr1zazn3&sign=5DC30EEA5783A34C39EAED2BEE96FE6D&publisher=%E4%B8%BB%E8%AE%B2%E4%BA%BAsadboy_%E6%B5%8B%E8%AF%95&channelId=1965681&timestamp=1621840557193

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	On success, returns the set channel ID. On failure, returns empty

Java Request Example

For quick integration of the basic code, please download the related dependency source code. Click to download 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(WebInfoTest.class);
/**
 * 修改频道主持人姓名
 * @throws IOException
 */
@Test
public void testSetPublisher() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId=super.appId;
    String appSecret=super.appSecret;
    String userId = super.userId;
    String timestamp=String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = String.format("http://api.polyv.net/live/v2/channelSetting/%s/setPublisher",userId);
    String publisher = "主讲人sadboy_测试";
    String channelId = "1965681";

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("publisher",publisher);
    requestMap.put("channelId",channelId);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url,requestMap);
    log.info("测试修改频道主持人姓名：{}",response);
    //do somethings

}

Response Example

For global system error descriptions, see Global Error Description

Success Example

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

Error Example

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

Live Streaming Server API