直播關聯自訂場次 ID

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

介面 URL

https://api.polyv.net/live/v3/channel/session/relevance

介面說明

1、接口用于
2、接口支持https

支援格式

JSON

請求方式

POST

請求數限制

TRUE

請求參數

參數名	必選	類型	說明
appId	是	string	從 API 設定中取得，在直播系統登記的 appId
timestamp	是	long	13 位當前時間戳
sign	是	String	簽名，為 32 位大寫的 MD5 值，`產生簽名的 appSecret 金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有 API 都必須透過客戶自己的伺服器中轉呼叫 POLYV 伺服器取得回應資料`【詳見簽名產生規則】
channelId	是	int	頻道號
externalSessionId	是	string	自訂直播場次 UUID，32 位長度

回應成功 JSON 範例：

{
  "code": 200, 
  "status": "success", 
  "message": "", 
  "data": "success"
}

回應失敗 JSON 範例：

未輸入 appId

{
    "code": 400,
    "status": "error",
    "message": "appId is required.",
    "data": ""
}

appId 不正確

{
    "code": 400,
    "status": "error",
    "message": "application not found.",
    "data": ""
}

時間戳錯誤

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

簽名錯誤

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

欄位說明

參數名	說明
code	回應代碼，成功為 200，失敗為 400，簽名錯誤為 401，異常錯誤 500
status	成功為 success，失敗為 error
message	錯誤時為錯誤提示訊息
data	修改成功時為 success

php 請求範例

<?php
//引用config.php
include '/srv/http/config.php';

$params = array(
  'appId' => $appId,
  'timestamp' => $timestamp,
  'channelId' => '206204',
  'externalSessionId' => '自定义直播场次UUID，32位长度');

//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法
$params['sign'] = $sign;

$url = "http://api.polyv.net/live/v3/channel/relevance-session?".http_build_query($params);

$curl = curl_init();
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_TIMEOUT, 500);
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_URL, $url);
$res = curl_exec($curl);
curl_close($curl);

echo $res;
?>