Query Channel List

Updated: 2023-11-09 11:01:14

API Description

1、根据分类id和频道名称查询频道号列表
2、接口支持https协议

API URL

http://api.polyv.net/live/v3/user/channels

Online API Call

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls are subject to rate 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 used directly on the client side. All APIs must be called through your own server to relay requests to the POLYV server for response data.` See Signature Generation Rules
categoryId	false	String	Returns the list of channel IDs under the specified category ID. If not provided, returns all channels under the account.
keyword	false	String	Channel name, fuzzy search
labelId	false	String	Label ID

Example

http://api.polyv.net/live/v3/user/channels?appId=frlr1zazn3&sign=D673B99508C8B99202D52A10FA77D091&keyword=%E8%AE%A8%E8%AE%BA&categoryId=340019&labelId=zpmz3640wkxpj267&timestamp=1621841285162

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	Object	Returns the channel list on success. See Data Field Description

Data Parameter Description

Parameter	Type	Description
channels	String[]	Returns the result set of 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, both included in the download 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(AccountTest.class);
/**
 * 查询频道列表
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testChannels() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url="http://api.polyv.net/live/v3/user/channels";
    String categoryId="340019";
    String keyword="讨论";
    String labelId = "zpmz3640wkxpj267";

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("categoryId", categoryId);
    requestMap.put("labelId", labelId);
    requestMap.put("keyword", keyword);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询频道列表，返回值：{}", response);
    //do somethings

}

Response Example

For global error descriptions, see Global Error Description

Success Example

{
    "code":200,
    "status":"success",
    "message":"",
    "data":{
        "channels":[
            2139283,
            2139268
        ]
    }
}

Error Example

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