积分打赏接口开发指引

功能介绍

POLYV支持与用户的积分系统对接,实现积分打赏。参照本文档提供的积分查询接口和积分更新接口,配置在POLYV后台的通用设置,使用系统生成的观看链接,配合外部授权、自定义授权或者白名单观看条件使用,观众在看直播时也可消耗积分并打赏给主播。

获取观众积分接口

说明

通过传递观众的id 和频道号等参数,对用户的积分查询接口URL 进行请求,获取学员在平台的积分

请求方式

GET

请求参数

参数 说明
channelId 频道号
viewerId 观众ID
ts 当前13位毫秒级时间戳
appId 账号在polyv后台的应用ID
sign 用于校验的sign,生成方法参考文档底部

接口返回要求

请求成功:
{
    "code":200,
    "status":"success",
    "message":"",
    "data":100.00
}
请求失败:
{
    "code":400,
    "status":"error",
    "message":"相关错误信息",
    "data":null
}
参数说明
参数 类型 说明
code int 接口请求状态码,200表示成功,非200表示失败
status string 接口请求状态,success 表示成功
message string 接口错误提示,注意:请求出错时,页面显示的提示为polyv积分打赏所设置的提示
data float 请求成功时为观众的积分

观众打赏道具接口(修改观众积分)

说明

观众观看页选择了相应道具进行打赏时,请求积分更新接口URL修改在平台的积分

请求方式

POST

请求参数

参数 说明
channelId 频道号
viewerId 观众ID
ts 当前13位毫秒级时间戳
appId 账号在polyv后台的应用ID
goodName 打赏的道具名称
goodPrice 账号在polyv后台的应用ID
sign 用于校验的sign,生成方法参考文档底部

接口返回要求

请求成功:
{
    "code":200,
    "status":"success",
    "message":"",
    "data":100.00
}
请求失败:
{
    "code":400,
    "status":"error",
    "message":"相关错误信息",
    "data":null
}
参数说明
参数 类型 说明
code int 接口请求状态码,200表示成功,非200表示失败
status string 接口请求状态,success 表示成功
message string 接口错误提示,注意:请求出错时,页面显示的提示为polyv积分打赏所设置的提示
data float 请求成功时为观众的剩余积分

sign的生成方法

为了保证接口的安全性,polyv观看页在请求接口时,会增加一个经过拼接生成的sign值,建议您在相应的代码里面增加对sign的校验,以确定接口的正常使用。

生成步骤

  1. 将要提交的所有非空参数和参数值根据参数名的进行字典序排列;
  2. 然后以: 参数名参数值参数名参数值进行拼接,拼接完后首尾带上appSecret
  3. 最后用MD5将字符串进行加密,加密后再大写

例如:
要发送的参数为:

channelId=10000, appId=app_trail, viewerId=viewer_test, ts=1558659759696;

按参数名字典序排序:

appId=app_trail, channelId=10000, ts=1558659759696, viewerId=viewer_test

拼接字符串并且首尾带上appSecret(从polyv后台获取,此处例如 6ef8d34c08f44e91a18428842ff0ba7e):

6ef8d34c08f44e91a18428842ff0ba7eappIdapp_trailchannelId10000ts1558659759696viewerviewer_testId6ef8d34c08f44e91a18428842ff0ba7e

通过MD5加密后再大写 得到最终的sign:

F42D596520782405C37021B853F0F805

参考示例:

    /**
     * 计算请求用户接口的sign
     */
    private String getSign(Map<String, String> paramMap, String appSecret) {
        //对参数名进行字典排序
        String[] keyArray = paramMap.keySet().toArray(new String[0]);
        Arrays.sort(keyArray);
        //拼接有序的参数串,首尾加上appSecret
        StringBuilder stringBuilder = new StringBuilder();
        stringBuilder.append(appSecret);
        for (String key : keyArray) {
            stringBuilder.append(key).append(paramMap.get(key));
        }
        stringBuilder.append(appSecret);
        // 最后用md5加密后再大写
        return EncryptionUtils.md5Hex(stringBuilder.toString()).toUpperCase();
    }
以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

直播内容审核回调功能

作用:

账号下频道直播内容异常(涉黄、涉爆、涉政)违规时触发,将违规频道的相关信息回调给用户

详情:

设置接口地址后,如果账号下频道内容违规时,直播系统会将以下参数channelId(频道号)、imageUrl(图片地址)、scene(违规类型:porn 涉黄, terrorism 暴恐涉政)、rate(结果为该类型的概率) 以 GET 方式提交到给用户自定义的回调接口进行通知,如:
http://abc.com/test.do?channelId=123456&imageUrl=http://xxxx/xxx/xxx.jpg&scene=porn&rate=90.0

参数名 类型 说明
channelId int 频道ID
imageUrl string 违规直播的截图,注意:图片为临时地址,请及时进行处理
scene string 违规类型,取值为porn(涉黄)、terrorism(暴恐涉政)
rate float 结果为该类型的概率,取值为[0.00-100.00],值越高表示越有可能属于该类型的概率

如何设置

通过后台设置

在直播后台中,点击【开发设置】,然后点击【回调设置】,在此进行设置
回调注意: 提交的接口地址必须要以http:// 或者https:// 开头

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

直播状态改变回调功能

作用:

账号下频道直播状态改变后,会对所设置的接口地址进行回调通知。

详情:

设置接口地址后,如果账号下频道有进行推流、断流操作导致频道直播状态改变,直播系统会将以下参数channelId(频道号)和status(直播状态:live表示开始直播,end表示直播结束)以GET方式提交到给用户自定义的回调接口进行通知,如:http://abc.com/test.do?channelId=123456&status=live

参数名 类型 说明
channelId int 频道ID
status string 直播频道的状态:live正在直播,end直播结束

如何设置

方法1:通过后台设置

在直播后台中,点击【开发设置】,然后点击【回调设置】,在此进行设置
回调

方法2:通过接口设置

设置直播状态修改回调接口地址

注意: 提交的接口地址必须要以http:// 或者https:// 开头

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

转存成功回调通知功能

作用:

账号下直播暂存文件成功转存至点播后,会对所设置的接口地址进行回调通知。

详情:

设置接口地址后,如果账号有进行暂存视频转存,即将直播生成的录制文件转存到点播中,如果转存视频处理完毕为已完成状态,直播系统会将以下参数channelId(频道号)、vid(转存成功的视频ID)、title(视频标题)、duration(视频时长)和fileSize(视频文件大小)以GET方式提交到给用户自定义的回调接口进行通知,如:http://abc.com/test.do?channelId=123456&vid=e6b23c6f5134943a015bc117e2854eae_e&title=视频标题&duration=01:23:45&fileSize=123400

参数名 类型 说明
channelId int 频道号ID
vid string 转存成功的视频ID
title string 视频标题
duration string 视频时长 格式为 hh:mm:ss
fileSize long 视频文件大小,单位为byte

如何设置

方法1:通过后台设置

登录账户-点击【开发设置】-点击【回调设置】-找到转存成功回调URL
16

方法2:通过接口设置

设置转存成功回调接口地址

注意: 提交的接口地址必须要以http:// 或者https:// 开头

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

回放生成回调通知接口

作用:

录制视频成功生成后,会对所设置的接口地址进行回调通知。

详情:

设置接口地址后,如果账号有开通录制功能,账号下各频道在推流结束,生成m3u8录制视频后,直播系统会将参数channelId(频道号)和fileUrl(录制文件地址)以GET方式提交到给用户自定义的回调接口进行通知,如:http://abc.com/test.do?channelId=104400&fileUrl=http://rflive.videocc.net/i6ro0hxj0020150529112242035/recordf.i6ro0hxj0020150529112242035_20170120184803.m3u8

如何设置

前提条件:账号已开通录制功能,可在频道详情处查看是否开通,如果未开通回放功能,则【回放回放视频】处显示,未开通录制功能。
14

方法1:通过后台设置

登录账户-点击【开发设置】-点击【回调设置】-找到回放生成回调URL
15

方法2:通过接口设置

录屏回调接口设置

注意: 提交的接口地址必须要以http:// 或者https:// 开头

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