查詢頻道資訊

介面描述

1、查询频道基本信息
2、接口支持https协议

介面URL

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

請求方式

GET

介面限制

1、介面同時支援HTTP、HTTPS，建議使用HTTPS以確保介面安全，介面呼叫有頻率限制，詳細請查看

請求參數描述

範例

http://api.polyv.net/live/v3/channel/basic/get?appId=frlr1zazn3&sign=A80D0E7115D0D1BF5648AE2AB123C0FD&channelId=1958888&timestamp=1621839827266

回應參數描述

data欄位說明

userCategory欄位說明

authSettings欄位說明

Java請求範例

快速接入基礎程式碼請下載相關依賴原始碼， 點擊下載原始碼 ，下載後加入到自己的原始碼工程中即可。測試用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。

強烈建議您使用直播Java SDK完成API的功能對接，直播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 查询频道基本信息
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetChannelDetailSetting() 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/basic/get";
    String channelId = "2139283";
    
    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
    
}

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "channelId": 1958888,
        "name": "Junit测试(勿删)888",
        "scene": "alone",
        "channelPasswd": "xxxxxx",
        "pureRtcEnabled":"N",
        "publisher": "sadboy主讲",
        "startTime": 0,
        "pageView": 1000,
        "likes": 2000,
        "coverImg": "//liveimages.videocc.net/uploaded/images/2021/03/fx6955h3q6.net",
        "splashImg": null,
        "splashEnabled": "N",
        "desc": "这是一个描述",
        "consultingMenuEnabled": "Y",
        "maxViewerRestrict": "N",
        "maxViewer": 0,
        "watchUrl": "https://1b448be323.live.polyv.cn/watch/1958888",
        "watchStatus": "end",
        "watchStatusText": "已结束",
        "userCategory": {
            "categoryId": 340019,
            "categoryName": "默认分类",
            "userId": "1b448be323",
            "rank": 0
        },
        "authSettings": [
            {
                "channelId": 1958888,
                "rank": 1,
                "userId": "1b448be323",
                "globalSettingEnabled": "N",
                "enabled": "Y",
                "authType": "pay",
                "authTips": "欢迎观看本次直播",
                "payAuthTips": "欢迎观看本次直播",
                "codeAuthTips": "欢迎观看本次直播",
                "infoAuthTips": "欢迎观看本次直播",
                "authCode": "xxxx",
                "qcodeTips": "提示文案",
                "qcodeImg": "//liveimages.videocc.net/uploaded/images/2021/03/fx69556szv.png",
                "price": 0.01,
                "watchEndTime": 1617077460000,
                "validTimePeriod": null,
                "customKey": "xxxxgn",
                "customUri": null,
                "externalKey": "xxxxxxxx",
                "externalUri": null,
                "externalRedirectUri": null,
                "directKey": "xxxxxxxx",
                "trialWatchEnabled": "Y",
                "trialWatchTime": 3,
                "trialWatchEndTime": 1617119999000,
                "whiteListInputTips": null,
                "whiteListEntryText": "会员入口",
                "infoDesc": null
            },
            {
                "channelId": 1958888,
                "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": "xxxxxxxx",
                "customUri": null,
                "externalKey": "xxxxxxxx",
                "externalUri": null,
                "externalRedirectUri": null,
                "directKey": "xxxxxxxx",
                "trialWatchEnabled": "N",
                "trialWatchTime": null,
                "trialWatchEndTime": null,
                "whiteListInputTips": null,
                "whiteListEntryText": "会员入口",
                "infoDesc": null
            }
        ],
        "bgImg": "https://car3.autoimg.cn/cardfs/product/g25/M08/C7/57/1024x0_1_q95_autohomecar__ChsEmF8EOK-AB5uaAAfsj_iwPdE906.jpg",
        "creatorChildId": null,
        "creatorName": null
    }
}

異常範例

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