Query Detailed Information of All Channels

Interface Description

1、查询账号下所有频道详细信息列表
2、接口支持https协议

API URL

http://api.polyv.net/live/v3/channel/management/list-detail

Request Method

POST

Interface Constraints

1. The interface supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. Interface calls are subject to frequency limits. For details, please refer to

Request Parameter Description

Example

http://api.polyv.net/live/v3/channel/management/list-detail

Form parameters:

watchStatus=playback&appId=frlr1zazn3&sign=BDEE4A11F8720DC0FD40E33DE159536B&pageSize=20&page=1&keyword=%E6%B5%8B%E8%AF%95&categoryId=345134&timestamp=1621841244430

Response Parameter Description

Data Parameter Description

Contents Parameter Description

authSetting Parameter Description

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 cases HttpUtil.java and LiveSignUtil.java are both included in the downloaded file.

It is strongly recommended that you use the Live Java SDK to complete the API functionality integration. The Live Java SDK provides a unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pooling.

private static final Logger log = LoggerFactory.getLogger(AccountTest.class);
/**
 * 查询所有频道的详细信息
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testChannelDetail() 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/channel/management/list-detail";
    String categoryId="345134";
    String watchStatus="playback";
    String keyword="测试";
    String page=String.valueOf(2);
    String pageSize=String.valueOf(20);

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("categoryId", categoryId);
    requestMap.put("watchStatus", watchStatus);
    requestMap.put("keyword", keyword);
    requestMap.put("page", page);
    requestMap.put("pageSize", pageSize);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试查询所有频道的详细信息，返回值：{}", response);
    //do somethings

}

Response Example

For a detailed explanation of system-wide errors, please refer to the Global Error Description.

Successful Example

{
    "code":200,
    "status":"success",
    "message":"",
    "data":{
        "pageSize":20,
        "pageNumber":1,
        "totalItems":1,
        "contents":[
            {
                "channelId":2191569,
                "name":"测试",
                "channelPasswd":"******",
                "categoryId":"345134",
                "scene":"ppt",
                "watchStatus":"playback",
                "watchStatusText":"回放中",
                "sceneText":"三分屏",
                "watchUrl":"https://live.polyv.cn/watch/2191569",
                "content":"这是直播介绍,可以是html代码",
                "startTime":1557888134000,
                "channelLogo":"//liveimages.videocc.net/uploaded/images/2021/03/fwzwkziu67.png",
                "splashImg":"//liveimages.videocc.net/uploaded/images/2021/03/fwzwkzkn9l.png",
                "splashEnabled":"Y",
                "publisher":"主持人名称",
                "authSetting":[
                    {
                        "channelId":2191569,
                        "rank":1,
                        "userId":"1b448be323",
                        "globalSettingEnabled":"N",
                        "enabled":"Y",
                        "authType":"external",
                        "authTips":"欢迎观看本次直播",
                        "payAuthTips":"欢迎观看本次直播",
                        "codeAuthTips":"欢迎观看本次直播",
                        "infoAuthTips":"欢迎观看本次直播",
                        "authCode":null,
                        "qcodeTips":null,
                        "qcodeImg":null,
                        "price":0,
                        "watchEndTime":null,
                        "validTimePeriod":null,
                        "customKey":"7020hnems4",
                        "customUri":null,
                        "externalKey":"L0EjokKI4O",
                        "externalUri":"http://demo.ipolyv.cn/chenwb/live-validate.php",
                        "externalRedirectUri":null,
                        "directKey":"56221g3rv0",
                        "trialWatchEnabled":"N",
                        "trialWatchTime":null,
                        "trialWatchEndTime":null,
                        "whiteListInputTips":null,
                        "whiteListEntryText":"会员入口",
                        "infoDesc":null
                    },
                    {
                        "channelId":2191569,
                        "rank":2,
                        "userId":"1b448be323",
                        "globalSettingEnabled":"N",
                        "enabled":"N",
                        "authType":"none",
                        "authTips":"欢迎观看本次直播",
                        "payAuthTips":"欢迎观看本次直播",
                        "codeAuthTips":"欢迎观看本次直播",
                        "infoAuthTips":"欢迎观看本次直播",
                        "authCode":null,
                        "qcodeTips":null,
                        "qcodeImg":null,
                        "price":0,
                        "watchEndTime":null,
                        "validTimePeriod":null,
                        "customKey":"7020hnems4",
                        "customUri":null,
                        "externalKey":"9oh7qu8656",
                        "externalUri":null,
                        "externalRedirectUri":null,
                        "directKey":"56221g3rv0",
                        "trialWatchEnabled":"N",
                        "trialWatchTime":null,
                        "trialWatchEndTime":null,
                        "whiteListInputTips":null,
                        "whiteListEntryText":"会员入口",
                        "infoDesc":null
                    }
                ]
            }
        ],
        "startRow":1,
        "firstPage":true,
        "lastPage":true,
        "prePageNumber":1,
        "limit":1,
        "endRow":1,
        "totalPages":1,
        "nextPageNumber":1,
        "offset":0
    }
}

Error Example

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