Query Channel Information

Old API endpoint Query Channel Info (Old Version)

Interface Description

1、查询频道基本信息，观看页状态与新版后台一致
2、接口支持https协议

API URL

http://api.polyv.net/live/v4/channel/basic/get

<a href="/req.html?api=http://api.polyv.net/live/v4/channel/basic/get"" target="_blank">Online API Call

Request Method

GET

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/v4/channel/basic/get?appId=frlr1zazn3&sign=AE9DED64FDDC94A0B18DB29E2D9B7DFC&channelId=3151318&timestamp=1654828588317

Response Parameter Description

Error Parameter Description

Description of the data field

labelData Field Description

Description of the userCategory Field

Description of the authSettings Field

Java Request Example

Quick Integration Basic Code Please download the relevant dependency source code, click here to download the source code. After downloading, add it to your own source 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 integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pooling.

private static final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 查询频道基本信息
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetChannelDetail() 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/v4/channel/basic/get";
    String channelId = "3151318";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询频道基本信息，返回值：{}", response);
    //do somethings
    
}

Response Example

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

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "4a11f50ed079498bba8d8886b069c5fa.65.16548285928827809",
    "data": {
        "channelId": 3151318,
        "name": "测试频道",
        "scene": "ppt",
        "newScene": "undefined",
        "template": "undefined",
        "channelPasswd": "8YiFH5",
        "publisher": "主持人",
        "startTime": 0,
        "endTime": 1687414806000,
        "newSessionEnabled": "Y",
        "pageView": 1,
        "likes": 0,
        "coverImg": "//liveimages.videocc.net/assets/wimages/pc_images/logo.png",
        "splashImg": "",
        "splashEnabled": "Y",
        "desc": "",
        "consultingMenuEnabled": "Y",
        "maxViewerRestrict": "N",
        "maxViewer": -1,
        "watchUrl": "https://1b448be323.live.polyv.cn/watch/3151318",
        "watchStatus": "unStart",
        "watchStatusText": "未开始",
        "userCategory": {
            "categoryId": 391352,
            "categoryName": "测试频道",
            "userId": "1b448be323",
            "rank": 3619
        },
        "authSettings": [
            {
                "channelId": 3151318,
                "userId": "1b448be323",
                "rank": 1,
                "globalSettingEnabled": "N",
                "enabled": "N",
                "authType": "info",
                "authTips": "欢迎观看本次直播",
                "payAuthTips": "欢迎观看本次直播",
                "codeAuthTips": "欢迎观看本次直播",
                "infoAuthTips": "欢迎观看本次直播",
                "authCode": "",
                "qcodeTips": "",
                "qcodeImg": "",
                "price": 0.00,
                "watchEndTime": null,
                "validTimePeriod": null,
                "customKey": "ujpTIPloEw",
                "customUri": "http://sadboy.cn/polyv.test?a=123&url=ijofdajodfsaoi",
                "externalKey": "ujpTIPloEw",
                "externalUri": "",
                "externalRedirectUri": "",
                "externalEntryText": "",
                "directKey": "ujpTIPloEw",
                "trialWatchEnabled": "N",
                "trialWatchTime": null,
                "trialWatchEndTime": null,
                "whiteListInputTips": "请输入会员码-1605067278063",
                "whiteListEntryText": "会员入口",
                "infoDesc": ""
            },
            {
                "channelId": 3151318,
                "userId": "1b448be323",
                "rank": 2,
                "globalSettingEnabled": "N",
                "enabled": "N",
                "authType": "none",
                "authTips": "欢迎观看本次直播",
                "payAuthTips": "欢迎观看本次直播",
                "codeAuthTips": "欢迎观看本次直播",
                "infoAuthTips": "欢迎观看本次直播",
                "authCode": "",
                "qcodeTips": "",
                "qcodeImg": "",
                "price": 0.00,
                "watchEndTime": null,
                "validTimePeriod": null,
                "customKey": "ujpTIPloEw",
                "customUri": "",
                "externalKey": "ujpTIPloEw",
                "externalUri": "",
                "externalRedirectUri": "",
                "externalEntryText": "",
                "directKey": "ujpTIPloEw",
                "trialWatchEnabled": "N",
                "trialWatchTime": null,
                "trialWatchEndTime": null,
                "whiteListInputTips": "",
                "whiteListEntryText": "会员入口",
                "infoDesc": ""
            }
        ],
        "bgImg": null,
        "onlyOutEnabled": "Y",
        "linkMicLimit": 16,
        "customTeacherId": "polyv001",
        "createdAccountId": "1b448be323",
        "createdAccountEmail": "sdk-demo@polyv.net",
        "createdTime": 1603155366000,
        "labelData":["zpmz3640wkxpj267"]
    },
    "success": true
}

Error Example

{
    "code": 400,
    "status": "error",
    "error": {
        "code": 10003,
        "desc": "时间戳过期"
    },
    "success": false
}