新版导播台使用说明

关于新版导播台:

新版导播台可实现多路异地直播同屏观看效果,适用于多个分会场的直播,新版导播台画面切换更快、画面更流畅,体验更佳。

新版导播台布局介绍:

导播台布局介绍

使用步骤:

创建路径:

(1)登录保利威视管理系统
(2)点击【云直播】,进入直播后台。
(3)点击【我的直播】,点击需要使用导播台的频道名称(若还没有创建频道,点击【新建直播】创建一个新频道)。
(4)在左侧菜单栏中找到【角色管理】。
(5)点击【打开导播台】进行创建。

QQ截图20190109095844

推流步骤:

(1)先在素材区添加素材。添加素材的方式有三种:使用客户端子频道推流、第三方推流、从点播中获取。成功添加视频后,视频会显示在素材区相应的位置。

添加素材

A.客户端推流:
使用刚创建的子频道号在POLYV直播客户端进行直播(客户端可选择:直播助手、大班课、Andorid云直播、iOS云直播)。
POLYV直播客户端下载地址
POLYV直播助手快速入门
B.第三方推流:
将推流地址复制至第三方工具。
OBS使用步骤
C.从点播中获取
进入保利威点播后台,将点播视频vid复制到添加素材弹窗的相应位置。
点播视频需为:非加密的高清视频

点播22

(2)添加布局。在布局区选择布局后,成功添加的布局显示在布局区。

选择布局

(3)选中布局区的某布局后,点击“开始导播”,预览界面显示混流后的效果。开始导播2
(4)点击“切换”,将预览画面切换至直播画面,观看页即可观看。切换到直播画面的素材,可对其音量进行调节。

切换

(5)点击“停止导播”,观看页将不再显示导播内容。

注意事项:

1. 导播过程中请勿关闭页面,关闭页面后,将结束导播。
2. 使用导播台时,请不要使用主频道推流。
以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

开通短信验证流程(腾讯云)

1. 腾讯云短信服务开通

a. 点击前往腾讯云短信服务平台,点击免费开通;
1
b. 按照网页指引完成登录;
2
c. 按照您的需求,选择认证类型;
3
注:①个人&企业认证指引;②完成认证后,认证类型还可以在账号信息->账号中心进行更改。
d. 完成认证后,自动跳转至腾讯云短信工作台,点击“添加应用”。
4
e. 输入应用名称和应用简介,完成应用创建。
5
f. 创建完成后,点击应用名称,进入短信应用配置界面。
6
g. 按照下图指引,复制SDK AppID和App Key;
APPID2
分别填写至直播后台“SDK AppID”和“App Key”处。
入口:开发设置-->短信平台设置。
8

2. 短信签名和短信正文模板创建

a. 短信签名和短信正文模板是什么?
temp
b. 依次点击“国内短信”->“短信内容配置”->“创建签名”。
9
c. 选择签名类型,并根据系统要求填写剩余内容。
10
d. 签名创建成功后会在2小时内完成审核。待签名审核通过后,按照下图指引,复制签名内容,并填写至直播后台“短信签名”处。
入口:开发设置-->短信平台设置。
签名212
e. 依次点击“短信正文”->“创建短信模板”。
13
f. 输入模板名称和短信内容,点击“确认”,完成正文模板创建。
14
注:
①“短信内容”可设置为:欢迎观看本次直播,您的登录验证码是{1}。如非本人操作,请忽略此短信。
②当前POLYV仅支持短信模板中有一个模板变量,请勿输入多个模板变量。
g. 正文模板创建成功后会在2小时内完成审核。待模板审核通过后,按照下图指引,复制模板ID内容,并填写至直播后台“模板ID”处。
入口:开发设置-->短信平台设置。
模板ID16

3. 短信余量预警绑定

a. 依次点击“应用配置”->“通知与告警”->“添加告警联系人”。
17
b. 输入联系人姓名、手机、邮箱,点击“确定”。
18
c. 告警联系人添加成功后,联系人将可以及时收到短信余量不足等预警。
您还可以在“套餐包管理”->“修改预警”中收到预警的短信余量阙值。
19
通过以上3步,即可完成保利威直播后台的短信平台设置。设置完成后,可以开启手机号码中短信验证的开关,在观看页中测试是否已经生效。

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

开通短信验证流程(阿里云)

阿里云短信服务新手指南

1. 注册短信服务商的企业账号

a. 点击前往阿里云注册入口。填写会员名、登录密码即可完成注册;
注册
b. 您也可点击右上角的“快捷登录”,用阿里云、淘宝等其他账号进行登录。
登录

2. 进行实名认证

a. 点击前往实名认证入口,若您已经完成实名验证,可以忽略这一步。
b. 如何进行认证?
-如何选择实名认证方式?
-个人用户如何完成实名认证?
-企业如何完成实名认证?
-事业单位、学校、机关、政府、社会团体如何完成实名认证?

3. 开通短信服务

a. 点击前往开通短信服务入口,勾选统一协议,并点击立即开通。
开通短信服务

4. 创建AccessKey

a. 入口:管理控制台-->AccessKey-->选择“继续使用AccessKey”或“开始使用子用户AccessKey”。
AccessKeyPicture
b. 点击创建AccessKey,将AccessKey ID与 AccessKey Secret填写至保利威直播后台“AccessKey ID”和“AccessKey Secret”处。
入口:开发设置-->短信平台设置
QQ截图201812131837281

5. 创建签名和模板

a. 什么是“短信签名”、“短信模板”?
短信签名介绍
b. 创建签名入口:短信服务控制台-->国内消息-->签名管理-->添加模板
创建短信签名
c. 点击添加签名,填写“签名”,选择“签名用途”,选择是否“三证合一”,上传证明文件,点击确认后,会在签名管理中显示添加的签名。
添加模板
添加的签名会在2小时内审核,在“审核状态”中会显示是否通过审核。
若未通过审核,可点击“操作”下的原因查看未审核通过的原因。
审核状态
d. 将通过审核的签名填写至直播后台“短信签名”处。
入口:开发设置-->短信平台设置-->短信签名
2
e. 创建模板入口:短信服务控制台-->国内消息-->模板管理-->添加模板
创建模板
f. 点击“添加模板”,选择“模板类型”,填写“模板名称”、“模板内容”、“申请说明”。
添加模板22
g. 提交后,该模板会在2小时内审核,审核成功的模板状态为“通过”。
添加模板3
将通过审核的模板code填写至直播后台“模板code”处。入口:开发设置-->短信平台设置-->模板code
3

6. 绑定手机号码

a.入口:管理控制台-->国内消息设置→绑定手机号码
b.为什么要绑定手机号码?
当套餐内的短信剩余数量到达预警时,阿里云平台会通知绑定的手机号。
绑定手机
通过以上6步,即可完成保利威直播后台的短信平台设置。设置完成后,可以开启手机号码中短信验证的开关,在观看页中测试是否已经生效。

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

获取频道的回放开关

接口URL

https://api.polyv.net/live/v3/channel/playback/get-enabled

接口说明

1、接口用于获取频道的回放开关
2、接口支持https

支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp long 13位当前时间戳
sign string 签名值
channelId int 频道号,不传该参数为获取全局设置

响应成功JSON示例:

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

响应失败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": 400, 
  "status": "error", 
  "message": "param is not digit: dsadasd", 
  "data": ""
}

字段说明

参数名 说明
code 响应代码,成功为200,失败为400,签名错误为401,异常错误500
status 成功为success,失败为error
message 错误时为错误提示消息
data 成功响应时为回放开关,Y(开启)、N(关闭)

php请求示例

<?php
//引用config.php
include '/srv/http/config.php';
$channelId = '要查询的频道号';
$params = array(
  'appId' => $appId,
  'channelId' => $channelId,
  'timestamp' => $timestamp
);

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

$url = "http://api.polyv.net/live/v3/channel/playback/get-enabled?".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;
?>

签名规则(config.php文件代码查看)

http://dev.polyv.net/2018/liveproduct/l-api/rule/sign/

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

推广设置(视频)

推广设置

推广设置功能,开启后,在移动端观看页可以弹出关注公众号的弹窗。
入口文案,可以自定义文案内容,这个入口会显示在自定义菜单栏的右侧。
上传企业公众号二维码,二维码大小不超过200K,支持jpg和png格式,
上传完成之后,可以设置二维码弹窗提示文案。
设置是否主动弹窗,关闭状态下,观众只有点击了入口按钮才会弹出二维码,开启弹窗后,观众只要打开观看页就会主动弹窗显示二维码。
最后,点击确认保存就可以了。

 

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

修改菜单排序

接口URL

http://api.polyv.net/live/v3/channel/menu/update-rank

接口说明

1、作用:修改直播频道的菜单的顺序
2、接口支持https协议

支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前时间的秒级时间戳(13位)
sign string 签名,为32位大写的MD5值
channelId int 频道号
menuIds string 频道菜单ID列表,必须是完整的列表(不能多也不能少),表示按该顺序排列菜单

操作成功响应示例

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

操作失败响应示例

签名错误

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

缺少参数 menuIds

{
    "code": 400,
    "status": "error"
    "message": "param should not be empty: menuIds",
    "data": ""
}

菜单ID列表错误(缺少菜单ID,或者有多余的、错误的菜单ID)

{
    "code": 400,
    "status": "error"
    "message": "illegal menu id: menuIds",
    "data": ""
}

响应字段说明

名称 类型 说明
code string 响应代码,成功为200,失败为400,签名错误为401,异常错误500
status string 成功为success,失败为error
message string 错误时为错误提示消息

php请求示例

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

$params = array(
  'appId' => $appId,
  'timestamp' => $timestamp,
  'channelId' => '123456',
  'menuIds' => '123,456'
);

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

$params["sign"] = $sign;
$url="http://api.polyv.net/live/v3/channel/menu/update-rank?".http_build_query($params);

function post($url, $post_data = '', $timeout = 5){
   $ch = curl_init();
   curl_setopt ($ch, CURLOPT_URL, $url);
   curl_setopt ($ch, CURLOPT_POST, 1);
   if($post_data != ''){
      curl_setopt($ch, CURLOPT_POSTFIELDS, $post_data);
   }

   curl_setopt ($ch, CURLOPT_RETURNTRANSFER, 1);
   curl_setopt ($ch, CURLOPT_CONNECTTIMEOUT, $timeout);
   curl_setopt($ch, CURLOPT_HEADER, false);
   curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json', 'Content-Length: ' . strlen($post_data)));
   $file_contents = curl_exec($ch);
   curl_close($ch);
   return $file_contents;
}

echo post($url);
?>

java请求示例

package com.live;

import java.io.IOException;
import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.apache.http.HttpEntity;
import org.apache.http.client.config.RequestConfig;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

import com.live.util.EncryptionUtils;

public class Demo {


    private static RequestConfig requestConfig = RequestConfig.custom().setSocketTimeout(15000).setConnectTimeout(15000)
            .setConnectionRequestTimeout(15000).build();

    public static void main(String[] args) {

        String url = "http://api.polyv.net/live/v3/channel/menu/update-rank";
        String appId = "appId";
        String key = "secretKey";
        Map<String, String> map = new HashMap<>();
        map.put("appId", appId);
        map.put("timestamp", String.valueOf(System.currentTimeMillis()));
        map.put("channelId", "123456");
        map.put("menuIds", "123,456");

        String sign = getSign(map, key);
        map.put("sign", sign);

        String body = "";
        String content = sendHttpPost(url, map, body);
        System.out.println(content);

    }

    /**
     * 发送 post请求
     * @param httpUrl 地址
     * @param maps 参数
     */
    public static String sendHttpPost(String httpUrl, Map<String, String> maps, String body) {
        StringBuilder url = new StringBuilder();
        url.append(httpUrl).append("?");
        for (Map.Entry<String, String> map : maps.entrySet()) {
            url.append(map.getKey()).append("=").append(map.getValue()).append("&");
        }
        String urlStr = url.toString().substring(0, url.length() - 1);

        System.out.println(urlStr);
        // 创建httpPost
        HttpPost httpPost = new HttpPost(urlStr);
        try {
            StringEntity entity = new StringEntity(body, Charset.forName("UTF-8"));
            httpPost.setEntity(entity);
        } catch (Exception e) {
            // ...
        }
        return sendHttpPost(httpPost);
    }

    /**
     * 发送Post请求
     * @param httpPost
     * @return
     */
    private static String sendHttpPost(HttpPost httpPost) {
        CloseableHttpClient httpClient = null;
        CloseableHttpResponse response = null;
        HttpEntity entity;
        String responseContent = null;
        try {
            // 创建默认的httpClient实例.
            httpClient = HttpClients.createDefault();
            httpPost.setConfig(requestConfig);
            // 执行请求
            response = httpClient.execute(httpPost);
            entity = response.getEntity();
            responseContent = EntityUtils.toString(entity, "UTF-8");
        } catch (Exception e) {
            // ...
        } finally {
            try {
                // 关闭连接,释放资源
                if (response != null) {
                    response.close();
                }
                if (null != httpPost) {
                    httpPost.releaseConnection();
                }
                if (httpClient != null) {
                    httpClient.close();
                }
            } catch (IOException e) {
                // ...
            }
        }
        return responseContent;
    }

    /**
     * 根据map里的参数构建加密串
     * @param map
     * @param secretKey
     * @return
     */
    protected static String getSign(Map<String, String> map, String secretKey) {
        Map<String, String> params = paraFilter(map);
        // 处理参数,计算MD5哈希值
        String concatedStr = concatParams(params);
        String plain = secretKey + concatedStr + secretKey;
        String encrypted = EncryptionUtils.md5Hex(plain);

        // 32位大写MD5值
        return encrypted.toUpperCase();
    }

    /**
     * 对params根据key来排序并且以key1=value1&key2=value2的形式拼接起来
     * @param params
     * @return
     */
    private static String concatParams(Map<String, String> params) {
        List<String> keys = new ArrayList<>(params.keySet());
        Collections.sort(keys);

        StringBuilder sb = new StringBuilder();

        for (int i = 0; i < keys.size(); i++) {
            String key = keys.get(i);
            String value = params.get(key);

            sb.append(key).append(value);
        }

        return sb.toString();
    }

    /**
     * 除去数组中的空值和签名参数
     * @param sArray 签名参数组
     * @return 去掉空值与签名参数后的新签名参数组
     */
    private static Map<String, String> paraFilter(Map<String, String> sArray) {

        Map<String, String> result = new HashMap<>();

        if (sArray == null || sArray.size() <= 0) {
            return result;
        }

        for (String key : sArray.keySet()) {
            String value = sArray.get(key);
            if (value == null || value.equals("") || key.equalsIgnoreCase("sign")
                    || key.equalsIgnoreCase("sign_type")) {
                continue;
            }
            result.put(key, value);
        }

        return result;
    }
}

签名规则(config.php文件代码查看)

http://dev.polyv.net/2018/liveproduct/l-api/rule/sign/

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

删除指定菜单

接口URL

https://api.polyv.net/live/v3/channel/menu/delete

接口说明

1、接口用于删除指定的频道菜单,支持批量
2、接口支持https

支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp long 13位当前时间戳
sign string 签名值
menuIds string 菜单id,指定多个以英文逗号,分隔

响应成功JSON示例:

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

响应失败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": ""
}

menuId分割后为空

{
  "code": 400, 
  "status": "error", 
  "message": "param length is incorrect: menuIds", 
  "data": ""
}

菜单不存在

{
  "code": 400, 
  "status": "error", 
  "message": "illegal menu id: test", 
  "data": ""
}

菜单类型不能删除

{
  "code": 400, 
  "status": "error", 
  "message": "can't delete special menu type", 
  "data": ""
}

字段说明

参数名 说明
code 响应代码,成功为200,失败为400,签名错误为401,异常错误500
status 成功为success,失败为error
message 错误时为错误提示消息
data 成功响应时为本次成功删除的个数

php请求示例

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

$params = array(
  'appId' => $appId,
  'timestamp' => $timestamp,
  'menuIds' => "9991391d9d,ea4375fcfb"
);

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

$url = "http://api.polyv.net/live/v3/channel/menu/delete?".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;
?>

签名规则(config.php文件代码查看)

http://dev.polyv.net/2018/liveproduct/l-api/rule/sign/

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

直播回放列表排序

接口URL

https://api.polyv.net/live/v3/channel/playback/sort

接口说明

1、接口用于排序回放列表。
2、通用参数通过普通url参数传递(channelId, timestamp, appId, sign),排序参数的json通过请求体的方式传递
3、接口支持https。

支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp long 13位当前时间戳
sign string 签名值
channelId int 频道号
videoIds string数组 完整回放视频ID列表,存放在请求体中,请求视频ID数量必须和回放列表数量一致,且不能少或者缺或者多

响应成功JSON示例:

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

响应失败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": 400, 
  "status": "error", 
  "message": "param is not digit: dsadasd", 
  "data": ""
}

请求体未传递videoIds错误

{
  "code": 400, 
  "status": "error",
  "message": "param validate error",
  "data": ""
}

数据库查询不到回放列表的视频错误

{
  "code": 400,
  "status": "error",
  "message": "playback video list is empty",
  "data": ""
}

回放视频ID错误(请求视频ID数量必须和回放列表数量一致,且不能少或者缺或者多)

{
  "code": 400,
  "status": "error",
  "message": "playback videoId error",
  "data": ""
}

字段说明

参数名 说明
code 响应代码,成功为200,失败为400,签名错误为401,异常错误500
status 成功为success,失败为error
message 错误时为错误提示消息
data 修改成功过时为true

php请求示例

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

$params = array(
  'appId' => $appId,
  'timestamp' => $timestamp,
  'channelId' => "209796"
);

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

$json = '{
    "videoIds": ["dsdadrerwf", "dadadaderr"]
}';

$params["sign"] = $sign;
$url="http://api.polyv.net/live/live/v3/channel/playback/sort?".http_build_query($params);

function post($url, $post_data = '', $timeout = 5){
   $ch = curl_init();
   curl_setopt ($ch, CURLOPT_URL, $url);
   curl_setopt ($ch, CURLOPT_POST, 1);
   if($post_data != ''){
      curl_setopt($ch, CURLOPT_POSTFIELDS, $post_data);
   }

   curl_setopt ($ch, CURLOPT_RETURNTRANSFER, 1);
   curl_setopt ($ch, CURLOPT_CONNECTTIMEOUT, $timeout);
   curl_setopt($ch, CURLOPT_HEADER, false);
   curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json', 'Content-Length: ' . strlen($post_data)));
   $file_contents = curl_exec($ch);
   curl_close($ch);
   return $file_contents;
}

echo post($url,$json);
?>

签名规则(config.php文件代码查看)

http://dev.polyv.net/2018/liveproduct/l-api/rule/sign/

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

修改功能开关设置

接口URL

https://api.polyv.net/live/v3/channel/switch/update

接口说明

1、接口用于修改功能开关设置,可修改全局开关设置或频道开关设置
2、接口支持https

支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp long 13位当前时间戳
sign string 签名值
channelId int 频道号,不传该参数为获取全局设置
type string 开关类型
enabled string 开关值,Y或N

开关类型

type 描述
isClosePreview 是否关闭系统观看页,Y时表示关闭
mobileWatch 是否开启移动端系统观看页
mobileAudio 是否开启移动端音视频切换
autoPlay 是否开启播放器自动播放功能
booking 是否开启预约功能
redPack 是否开启红包功能
shareBtnEnabled 是否开启分享功能
chat 是否开启聊天室
closeChaterList 是否关闭在线列表,Y时表示关闭
consultingMenu 是否开启咨询提问
closeDanmu 是否关闭弹幕功能,Y时表示关闭
praise 是否开启点赞语功能
welcome 是否开启欢迎语功能
viewerSendImgEnabled 是否开启观众发送图片

注:isClosePreview当enabled值为Y时,表示的是关闭系统观看页;closeDanmu当enabled值为Y时,表示的是关闭弹幕;closeChaterList当enabled值为Y时,表示的是关闭在线列表

响应成功JSON示例:

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

响应失败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": 400, 
  "status": "error", 
  "message": "param is not digit: dsadasd", 
  "data": ""
}

字段说明

参数名 说明
code 响应代码,成功为200,失败为400,签名错误为401,异常错误500
status 成功为success,失败为error
message 错误时为错误提示消息
data 修改成功过时为true

php请求示例

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

$params = array(
  'appId' => $appId,
  'timestamp' => $timestamp,
  'channelId' => '206204',
  'type' => 'viewerSendImgEnabled',
  'enabled' => 'N'
);

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

$url = "http://api.polyv.net/live/v3/channel/switch/update?".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;
?>

签名规则(config.php文件代码查看)

http://dev.polyv.net/2018/liveproduct/l-api/rule/sign/

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

获取功能开关设置接口

接口URL

https://api.polyv.net/live/v3/channel/switch/get

接口说明

1、接口用于获取开关设置,可获取全局开关设置或频道开关设置
2、接口支持https

支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp long 13位当前时间戳
sign string 签名值
channelId int 频道号,不传该参数为获取全局设置

响应成功JSON示例:

{
  "code": 200, 
  "status": "success", 
  "message": "", 
  "data": [
    {
      "type": "isClosePreview", 
      "enabled": "N"
    }, 
    {
      "type": "mobileWatch", 
      "enabled": "Y"
    }, 
    {
      "type": "mobileAudio", 
      "enabled": "Y"
    }, 
    {
      "type": "autoPlay", 
      "enabled": "Y"
    }, 
    {
      "type": "booking", 
      "enabled": "Y"
    }, 
    {
      "type": "redPack", 
      "enabled": "Y"
    }, 
    {
      "type": "shareBtnEnabled", 
      "enabled": "Y"
    }, 
    {
      "type": "chat", 
      "enabled": "Y"
    }, 
    {
      "type": "closeChaterList", 
      "enabled": "N"
    }, 
    {
      "type": "consultingMenu", 
      "enabled": "Y"
    }, 
    {
      "type": "closeDanmu", 
      "enabled": "N"
    }, 
    {
      "type": "praise", 
      "enabled": "Y"
    }, 
    {
      "type": "welcome", 
      "enabled": "Y"
    }, 
    {
      "type": "chatPlayBack", 
      "enabled": "Y"
    }, 
    {
      "type": "viewerSendImgEnabled", 
      "enabled": "Y"
    }
  ]
}

响应失败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": 400, 
  "status": "error", 
  "message": "param is not digit: dsadasd", 
  "data": ""
}

字段说明

参数名 说明
code 响应代码,成功为200,失败为400,签名错误为401,异常错误500
status 成功为success,失败为error
message 错误时为错误提示消息
data 成功响应时为当前开关设置项
type 开关类型
enabled 是否已打开开关

注:isClosePreview当enabled值为Y时,表示的是关闭系统观看页;closeDanmu当enabled值为Y时,表示的是关闭弹幕;closeChaterList当enabled值为Y时,表示的是关闭在线列表

php请求示例

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

$params = array(
  'appId' => $appId,
  'timestamp' => $timestamp
);

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

$url = "http://api.polyv.net/live/v3/channel/switch/get?".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;
?>

签名规则(config.php文件代码查看)

http://dev.polyv.net/2018/liveproduct/l-api/rule/sign/

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...