> For the complete documentation index, see [llms.txt](https://polyv.gitbook.io/document/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://polyv.gitbook.io/document/docs/unclassified/2020/d57e7376b8dadf942563f0389b1a4c3b.md).

# 获取直播监控信息接口

### 接口URL

```
https://api.polyv.net/live/v3/channel/monitor/get-info
```

### 接口说明

```
1、作用：用于获取直播监控信息
2、接口支持https协议
```

### 支持格式

```
JSON
```

### 请求方式

```
GET
```

### 请求数限制

```
TRUE
```

### 请求参数

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

### 操作成功响应示例

```json
{
  "code": 200,
  "message": "",
  "status": "success",
  "data": {
  	"userId": "xxxxx",
    "status": "N",
    "banPush": "N",
    "scene": "alone",
    "debugEnabled": "N",
    "marqueeEnabled": "Y",
    "consultingMenuEnabled": "Y",
    "cdnType": "uc",
    "sign": "xxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "roomIds": "",
    "roomSign": "xxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "chatTranslateEnabled": "Y",
    "showCustomMessageEnabled": "Y",
    "chatAdmin": {
      "channelId": xxxxxx,
      "type": "admin",
      "nickname": "管理员",
      "actor": "管理员",
      "avatar": "//s1.videocc.net/face.png",
      "createdTime": 1588678231000,
      "lastModified": 1588678231000
    },
    "chatToken": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "chatEnabled": "Y"
  }
}
```

### 操作失败响应示例

签名错误

```json
{
    "code": 403,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}
```

### 响应字段说明

| 名称                            | 类型     | 说明                                                    |
| ----------------------------- | ------ | ----------------------------------------------------- |
| code                          | string | 响应代码，成功为200，失败为400，签名错误为403，异常错误500                   |
| status                        | string | 成功为success，失败为error                                   |
| message                       | string | 错误时为错误提示消息                                            |
| data                          | object | 成功返回信息                                                |
| data.userId                   | string | 用户ID                                                  |
| data.status                   | string | 当前是否是直播状态（Y/N）                                        |
| data.banPush                  | string | 是否是禁止推流状态（Y/N）                                        |
| data.scene                    | string | 当前直播场景 （"alone" : 普通直播；"topclass" : 大班课；"ppt" : 三分屏 ） |
| data.debugEnabled             | string | 是否开启了调试模式（Y/N）                                        |
| data.marqueeEnabled           | string | 跑马灯开关（Y/N）                                            |
| data.consultingMenuEnabled    | string | 咨询提问开关（Y/N）                                           |
| data.cdnType                  | string | cdn类型                                                 |
| data.sign                     | string | 频道号房间聊天室sign                                          |
| data.roomIds                  | string | 多房间ID                                                 |
| data.roomSign                 | string | 多房间聊天室sign                                            |
| data.chatTranslateEnabled     | string | 聊天室翻译开关（Y/N）                                          |
| data.showCustomMessageEnabled | string | 是否展示自定义消息开关（Y/N）                                      |
| data.chatToken                | string | 聊天室token                                              |
| data.chatAdmin                | object | 聊天室管理员信息对象                                            |
| data.chatAdmin.channelId      | int    | 聊天室对应频道号                                              |
| data.chatAdmin.type           | string | 聊天室角色类型                                               |
| data.chatAdmin.nickname       | string | 聊天室管理员昵称                                              |
| data.chatAdmin.actor          | string | 聊天室管理员头衔                                              |
| data.chatAdmin.avatar         | string | 聊天室管理员头像                                              |
| data.chatAdmin.createdTime    | string | 聊天室管理员创建时间                                            |
| data.chatAdmin.lastModified   | string | 聊天室管理员更新时间                                            |

### php请求示例

```php
<?php

//引用config.php
include 'config.php';

$params = array(
        'appId'=>$appId,
        'channelId'=>$channelId,
        'timestamp'=>$timestamp
    );

//生成sign
$sign = getSign($params); //详细查看config.php文件
$params['sign'] = $sign;
$url="https://api.polyv.net/live/v3/channel/monitor/get-info?".http_build_query($params);
echo "<script>window.location.href='$url'</script>";
?>

```