取得呼叫聊天室介面所需的 sign 介面

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

介面 URL

https://api.polyv.net/live/v3/channel/monitor/get-room-sign

介面說明

1、作用：用於取得呼叫聊天室介面所需的 sign
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": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}

操作失敗回應範例

簽名錯誤

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

回應欄位說明

名稱	類型	說明
code	string	回應代碼，成功為 200，失敗為 400，簽名錯誤為 403，異常錯誤為 500
status	string	成功為 success，失敗為 error
message	string	錯誤時的錯誤提示訊息
data	string	成功回傳聊天室介面所需的 sign

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-room-sign?".http_build_query($params);
echo "<script>window.location.href='$url'</script>";
?>