保利威文档中心

帮助中心

修改积分打赏开关

更新时间: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;

?>
联系客服,在线咨询