查询频道信息

接口描述

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

接口URL

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

在线API调用

请求方式

GET

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看

请求参数描述

示例

http://api.polyv.net/live/v3/channel/basic/get-channel?appId=frlr1zazn3&sign=4049473DAEBBEFF778DABD1A25E3409B&channelId=2779045&timestamp=1642732753732

响应参数描述

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 testGetChannel() 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-channel";
    String channelId = "2779045";
    
    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": 2779045,
        "name": "测试",
        "scene": "alone",
        "newScene": "alone",
        "template": "portrait_alone",
        "channelPasswd": "6dMuVz",
        "publisher": "主持人",
        "startTime": 0,
        "pageView": 6,
        "likes": 0,
        "coverImg": "//liveimages.videocc.net/assets/wimages/pc_images/logo.png",
        "splashImg": "//liveimages.videocc.net/uploaded/images/2021/09/g2bta2pjbw.jpg",
        "splashEnabled": "Y",
        "desc": "",
        "consultingMenuEnabled": "Y",
        "maxViewerRestrict": "N",
        "maxViewer": -1,
        "watchStatus": "unStart",
        "watchStatusText": "未开始",
        "userCategory": {
            "categoryId": 340019,
            "categoryName": "默认分类",
            "userId": "1b448be323",
            "rank": 0
        },
        "authSettings": [
            {
                "channelId": 2779045,
                "rank": 1,
                "userId": "1b448be323",
                "globalSettingEnabled": "N",
                "enabled": "N",
                "authType": "external",
                "authTips": "欢迎观看本次直播",
                "payAuthTips": "欢迎观看本次直播",
                "codeAuthTips": "欢迎观看本次直播",
                "infoAuthTips": "欢迎观看本次直播",
                "authCode": "",
                "qcodeTips": null,
                "qcodeImg": null,
                "price": 0.01,
                "watchEndTime": null,
                "validTimePeriod": null,
                "customKey": "ujpTIPloEw",
                "customUri": "",
                "externalKey": "ujpTIPloEw",
                "externalUri": "http://www.polyv.net",
                "externalRedirectUri": "",
                "externalEntryText": "登录观看",
                "directKey": "ujpTIPloEw",
                "trialWatchEnabled": "N",
                "trialWatchTime": 1,
                "trialWatchEndTime": null,
                "whiteListInputTips": "请输入会员码-1605067278063",
                "whiteListEntryText": "会员入口",
                "infoDesc": ""
            },
            {
                "channelId": 2779045,
                "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": "ujpTIPloEw",
                "customUri": null,
                "externalKey": "ujpTIPloEw",
                "externalUri": null,
                "externalRedirectUri": null,
                "externalEntryText": "",
                "directKey": "ujpTIPloEw",
                "trialWatchEnabled": "N",
                "trialWatchTime": null,
                "trialWatchEndTime": null,
                "whiteListInputTips": null,
                "whiteListEntryText": "会员入口",
                "infoDesc": null
            }
        ],
        "bgImg": "",
        "creatorChildId": null,
        "creatorName": null,
        "onlyOutEnabled": "Y"
    }
}

异常示例

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