保利威文档中心

幫助中心

修改積分打賞開關

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

介面URL

http://api.polyv.net/live/v3/channel/donate/update-point-enabled

介面說明

1、作用:修改積分打賞開關,不傳channelId 修改全域積分打賞開關
2、全域積分打賞開關關閉時,如果開啟頻道的積分打賞,將會回傳失敗
3、介面支援https協定

請求方式

POST

請求參數

參數名 必選 類型 說明
appId string 從API設定中取得,在直播系統登記的appid
sign String 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則
timestamp string 當前13位毫秒級時間戳,3分鐘內有效
donatePointEnabled string 積分打賞開關,值為Y/N,必填
channelId int 頻道ID,不傳該參數表示修改全域積分打賞開關

回應成功JSON範例

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

回應異常JSON範例

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

回應參數

參數名 說明
status 回應狀態
data 回應結果
code http回應狀態碼
message 異常錯誤資訊

PHP請求範例

<?php

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

//接口需要的参数(非sign)赋值
$userId = "XXXXXXXX";
$channelId = "127075";
$donatePointEnabled = "N";
$params = array(
        'appId'=>$appId,
        'donatePointEnabled'=>$donatePointEnabled,
        'channelId'=>$channelId,
        'timestamp'=>$timestamp
    );
//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法

$url="http://api.polyv.net/live/v3/channel/donate/update-point-enabled?appId=$appId&channelId=$channelId&donatePointEnabled=$donatePointEnabled&sign=$sign&timestamp=$timestamp";

$ch = curl_init() or die ( curl_error() );
curl_setopt( $ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1 );
curl_setopt( $ch, CURLOPT_CONNECTTIMEOUT, 360);
$response = curl_exec ( $ch );
curl_close ( $ch );
echo $response;

?>
联系客服,在线咨询