取得直播監控資訊介面

更新時間：2022-09-02 18:08:07

介面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伺服器取得回應資料`【詳見簽名產生規則】
channelId	是	int	頻道號

操作成功回應範例

{
  "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"
  }
}

操作失敗回應範例

簽名錯誤

{
    "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

//引用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>";
?>