# 查询频道信息

旧版接口地址[查询频道信息(旧版)](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/channel/operate/get_channel_detail_setting/README.md)

### 接口描述

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

### 接口URL

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

[在线API调用](https://git.polyv.net/help-center/document-center/-/blob/master/req.html?api=http:/api.polyv.net/live/v4/channel/basic/get/README.md)

### 请求方式

```
GET
```

### 接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，[详细请查看](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/limit/README.md)

### 请求参数描述

| 参数名       | 必选   | 类型     | 说明                                                                                                                                                                                                        |
| --------- | ---- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| appId     | true | String | 账号appId【详见[获取密钥](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/getSecretKey/README.md)】                                                                                        |
| timestamp | true | Long   | 当前13位毫秒级时间戳，3分钟内有效                                                                                                                                                                                        |
| sign      | true | String | 签名，为32位大写的MD5值,`生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见[签名生成规则](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/buildSign/README.md)】 |
| channelId | true | String | 频道号                                                                                                                                                                                                       |

### 示例

```requestUrl
http://api.polyv.net/live/v4/channel/basic/get?appId=frlr1zazn3&sign=AE9DED64FDDC94A0B18DB29E2D9B7DFC&channelId=3151318&timestamp=1654828588317
```

### 响应参数描述

| 参数名       | 类型      | 说明                                       |
| --------- | ------- | ---------------------------------------- |
| code      | Integer | 状态码，与 http 状态码相同，用于确定基本的响应状态             |
| status    | String  | 响应结果，由业务决定，成功返回success，失败返回error         |
| success   | Boolean | 是否成功响应                                   |
| requestId | String  | 请求ID，每次请求生成的唯一的 UUID，仅可用于排查、调试，不应该和业务挂上钩 |
| error     | Object  | 状态码非200时的错误信息【详见[Error字段描述](#error参数描述)】 |
| data      | Object  | 【详见[data字段说明](#data字段说明)】                |

### Error参数描述

| 参数名  | 类型      | 说明                   |
| ---- | ------- | -------------------- |
| code | Integer | 错误代码，用于确定具体的错误原因     |
| desc | String  | 错误描述，与 error.code 对应 |

#### data字段说明

| 参数名                              | 类型      | 说明                                                                                                                                                                     |
| -------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| channelId                        | String  | 频道号                                                                                                                                                                    |
| name                             | String  | 频道名称                                                                                                                                                                   |
| scene                            | String  | <p>直播场景，新版直播不使用该字段<br>alone：活动直播<br>topclass：大班课<br>ppt：三分屏<br>seminar：研讨会</p>                                                                                         |
| newScene                         | String  | <p>新版后台直播场景，若未定义则取scene<br>undefined：未定义<br>topclass：大班课<br>double：双师课（需开通权限）<br>train：企业培训<br>seminar：研讨会<br>alone：活动营销</p>                                           |
| template                         | String  | <p>新版后台直播模板，若老版频道，该字段为未定义<br>undefined：未定义<br>ppt：三分屏(横屏)<br>alone：纯视频(横屏)<br>topclass：纯视频-极速(横屏)<br>seminar：研讨会<br>portrait_ppt：三分屏(竖屏)<br>portrait_alone：纯视频(竖屏)</p> |
| channelPasswd                    | String  | 频道密码                                                                                                                                                                   |
| publisher                        | String  | 主持人名称                                                                                                                                                                  |
| startTime                        | Long    | 直播间设置的直播开始时间（设置后出现倒计时），未设置直播开始时间或重置了直播开始时间时为0；设置并生效时为13位毫秒级时间戳。                                                                                                        |
| endTime                          | Long    | 直播间设置的直播结束时间，13位毫秒级时间戳。                                                                                                                                                |
| pureRtcEnabled                   | String  | 频道无延迟直播开关，Y:开启，N:关闭                                                                                                                                                    |
| pageView                         | Integer | 页面累计观看数                                                                                                                                                                |
| likes                            | Integer | 观看页点赞数                                                                                                                                                                 |
| coverImg                         | String  | 频道图标                                                                                                                                                                   |
| splashImg                        | String  | 引导页图片地址                                                                                                                                                                |
| splashEnabled                    | String  | <p>引导页开关<br>Y：开启<br>N：关闭</p>                                                                                                                                           |
| bgImg                            | String  | 播放器封面图片URL                                                                                                                                                             |
| desc                             | String  | 直播介绍                                                                                                                                                                   |
| consultingMenuEnabled            | String  | <p>咨询提问开关<br>Y：开启<br>N：关闭</p>                                                                                                                                          |
| maxViewerRestrict                | String  | <p>限制最大在线观看人数开关<br>Y：开启<br>N：关闭</p>                                                                                                                                    |
| maxViewer                        | Integer | 最大在线观看人数                                                                                                                                                               |
| watchStatus                      | String  | <p>观看页状态<br>live：直播中<br>playback：回放中<br>end：已结束<br>waiting：等待中<br>unStart：未开始<br>banpush：已禁播</p>                                                                       |
| watchStatusText                  | String  | 观看页状态描述                                                                                                                                                                |
| userCategory                     | Object  | 频道所属分类的信息【详见[userCategory字段说明](#userCategory字段说明)】                                                                                                                     |
| authSettings                     | Array   | 直播观看条件列表 【详见[authSettings字段说明](#authSettings字段说明)】                                                                                                                     |
| linkMicLimit                     | Integer | 频道连麦人数限制                                                                                                                                                               |
| createdAccountId                 | String  | 创建者账号id，为主账号创建时，返回主账号userId                                                                                                                                            |
| createdAccountEmail              | String  | 创建者账号邮箱                                                                                                                                                                |
| createdTime                      | Long    | 创建时间，13位时间戳                                                                                                                                                            |
| labelData                        | Array   | 标签id数组 【详见[labelData字段说明](#labelData字段说明)】                                                                                                                             |
| clientAloneTemplateBackgroundUrl | String  | 客户端模版背景图URL                                                                                                                                                            |
| liveCdnBackgroundUrl             | String  | 视频混流背景图URL                                                                                                                                                             |

#### labelData字段说明

| 参数名 | 类型     | 说明   |
| --- | ------ | ---- |
| id  | String | 标签ID |

#### userCategory字段说明

| 参数名          | 类型      | 说明                                       |
| ------------ | ------- | ---------------------------------------- |
| categoryId   | String  | 分类ID                                     |
| categoryName | String  | 分类名称                                     |
| userId       | String  | POLYV用户ID，和保利威官网一致，获取路径：官网->登录->直播（开发设置） |
| rank         | Integer | 分类的排序值                                   |

#### authSettings字段说明

| 参数名                    | 类型      | 说明                                                                                                                                                  |
| ---------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| channelId              | String  | 频道号                                                                                                                                                 |
| rank                   | Integer | 频道直播观看条件，主要观看条件为1，次要观看条件为2                                                                                                                          |
| userId                 | String  | POLYV用户ID，和保利威官网一致，获取路径：官网->登录->直播（开发设置）                                                                                                            |
| globalSettingEnabled   | String  | <p>是否开启全局设置<br>Y：开启<br>N：关闭</p>                                                                                                                     |
| enabled                | String  | <p>是否开启观看条件<br>Y：开启<br>N：关闭</p>                                                                                                                     |
| authType               | String  | <p>观看条件类型<br>none：无限制<br>code：验证码观看<br>pay：付费观看<br>phone：白名单观看<br>info：登记观看<br>wxshare：分享观看<br>custom：自定义授权观看<br>external：外部授权观看<br>direct：独立授权</p> |
| authTips               | String  | 白名单观看提示信息                                                                                                                                           |
| payAuthTips            | String  | 付费观看提示信息                                                                                                                                            |
| codeAuthTips           | String  | 验证码观看条件提示信息                                                                                                                                         |
| infoAuthTips           | String  | 登记观看条件提示信息                                                                                                                                          |
| authCode               | String  | 验证码观看的验证码                                                                                                                                           |
| qcodeTips              | String  | 验证码观看的二维码提示                                                                                                                                         |
| qcodeImg               | String  | 验证码观看的二维码图片                                                                                                                                         |
| price                  | Float   | 付费观看的价格                                                                                                                                             |
| watchEndTime           | Long    | 付费观看截止时间，13位毫秒级时间戳，为 null 表示一次付费，永久有效                                                                                                               |
| validTimePeriod        | Integer | 付费观看的截止时长，单位为天                                                                                                                                      |
| customKey              | String  | 自定义授权观看的 key                                                                                                                                        |
| customUri              | String  | 自定义授权观看的接口地址                                                                                                                                        |
| externalKey            | String  | 外部授权观看的 key                                                                                                                                         |
| externalUri            | String  | 外部授权观看的接口地址                                                                                                                                         |
| externalRedirectUri    | String  | 外部授权观看，用户直接访问观看页时的跳转地址                                                                                                                              |
| directKey              | String  | 独立授权 key                                                                                                                                            |
| trialWatchEnabled      | String  | <p>付费观看的试看开关，默认关闭<br>Y：开启<br>N：关闭</p>                                                                                                               |
| trialWatchTime         | Integer | 试看时间，单位为分钟                                                                                                                                          |
| trialWatchEndTime      | Long    | 试看截止日期，13位毫秒级时间戳，为 null 表示对该频道永久有效                                                                                                                  |
| whiteListInputTips     | String  | 白名单输入提示                                                                                                                                             |
| whiteListEntryText     | String  | 白名单入口文案                                                                                                                                             |
| infoDesc               | String  | 登记观看描述字段                                                                                                                                            |
| customTeacherId        | String  | 自定义讲师ID                                                                                                                                             |
| expectedArrivalEnabled | String  | 当authType为phone时使用，到课名单开关，Y：开启，N：关闭                                                                                                                 |
| ### Java请求示例           |         |                                                                                                                                                     |

快速接入基础代码请下载相关依赖源码， [点击下载源代码](https://git.polyv.net/help-center/document-center/-/blob/master/third_res/util.zip) ,下载后加入到自己的源码工程中即可。测试用例中的**HttpUtil.java 和 LiveSignUtil.java** 都包含在下载文件中。

> 强烈建议您使用[直播Java SDK](https://git.polyv.net/help-center/document-center/-/blob/master/live/java/README.md)完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

```java
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
    
}
```

### 响应示例

系统全局错误说明详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/errorInfo/README.md)

成功示例

```json
{
    "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,
        "pageView": 1,
        "likes": 0,
        "coverImg": "//liveimages.videocc.net/assets/wimages/pc_images/logo.png",
        "splashImg": "",
        "splashEnabled": "Y",
        "desc": "",
        "consultingMenuEnabled": "Y",
        "maxViewerRestrict": "N",
        "maxViewer": -1,
        "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
}
```

异常示例

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