Batch Associate or Disassociate Receive Relay Channel Settings

Updated: 2025-02-25 14:52:08

Interface Description

1、批量关联或者取消关联接收转播频道设置
2、接口支持https协议

Interface URL

https://api.polyv.net/live/v3/channel/transmit/associations

Online API Call

Request Method

POST

Interface Constraints

The interface supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. Interface 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 details on signature generation rules
channelId	true	String	Relay channel ID
receiveChannelIds	true	String	Receive channel IDs to associate or disassociate, separated by commas for multiple IDs
type	false	String	Operation type. Values: add (associate), cancel (disassociate). Default is add (associate)

Example

https://api.polyv.net/live/v3/channel/transmit/associations

Form parameters:

receiveChannelIds=12933,2938322&appId=frlr1zazn3&sign=2A861BD280299A4D7E6FF556C77C88D2&channelId=2149710&timestamp=1621843071824&type=add

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code. 200 indicates success, non-200 indicates failure See details on global error descriptions
status	String	Response status text
message	String	Response description. When code is 400 or 500, provides additional error reason description
data	String	On success, returns the array of successfully operated receive channel IDs

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 functionality 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
 * @throws NoSuchAlgorithmException
 */
@Test
public void testAddOrCancelReceiveChannels() 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/v3/channel/transmit/associations";
    String channelId = "2149710";
    String receiveChannelIds = "1238222,32232,323234,4444445";
    String type = "add";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("receiveChannelIds", receiveChannelIds);
    requestMap.put("type", type);
    requestMap.put("channelId", channelId);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试批量关联或者取消关联接收频道设置，返回值：{}", response);
    //do somethings
    
}

Response Example

See Global Error Descriptions for system-wide error descriptions.

Success Example

{
    "code":200,
    "status":"success",
    "message":"",
    "data":[1222,323232,4444444]
}

Error Example

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

Live Streaming Server API