Query Relay Channel Information

Updated: 2024-04-22 19:18:32

API Description

1、查询账号或频道下的转播列表信息
2、接口支持https协议

API URL

http://api.polyv.net/live/v3/channel/transmit/get-associations

Online API Call

Request Method

GET

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 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 retrieve response data.` See Signature Generation Rules
channelId	false	String	The initiating relay channel ID. If not provided, queries all relay channel associations under the account corresponding to appId.

Example

https://api.polyv.net/live/v3/channel/transmit/get-associations?appId=frlr1zazn3&sign=37A6FD50B2FEEC94A779A77E26E5AF25&timestamp=1621843161944

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code, 200 for success, non-200 for failure See Global Error Description
status	String	Response status text
message	String	Response description, provides error details when code is 400 or 500
data	Array	On success, returns an array of relay channel list information under the account See Data Field Description

Data Parameter Description

Parameter	Type	Description
channelId	String	The initiating relay channel ID. If a receiving relay channel is not associated with a main channel, this value is null
receiveChannelId	String	The receiving relay channel ID

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click to download source code. After downloading, add it to your own source 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(ChannelOperateTest.class);
/**
 * 查询转播频道信息
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetTransmitAssociations() 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/get-associations";
    String channelId="2191569";

    //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.get(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":[
        {
            "channelId":null,
            "receiveChannelId":2191541
        },
        {
            "channelId":null,
            "receiveChannelId":2191532
        },
        {
            "channelId":null,
            "receiveChannelId":1972965
        }
    ]
}

Error Example

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