Web Interact
1、设置道具打赏
描述
调用约束
1、接口调用有频率限制,详细请查看,调用常见异常,详细请查看
单元测试
单元测试说明
1、请求正确,返回Boolean对象,B端依据此对象处理业务逻辑;
2、请求参数校验不合格,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败,失败字段 [pic不能为空 / msg不能为空] ]
3、服务器处理异常,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 保利威请求返回数据错误,请求流水号:66e7ad29fd04425a84c2b2b562d2025b,错误原因: invalid signature. ]
请求入参描述
channelId
false
String
频道号,不传为全局设置
enabled
false
String
请求体参数,道具打赏开关,不传默认开启,值为 Y/N , Y为开启
goods
true
Array
goodName
true
String
道具名称,不能超过5个字符
goodImg
true
String
道具图片,不能超过120个字符(通过上传图片接口上传获取图片地址,或者使用默认地址;鲜花:01-flower.png;咖啡:02-coffee.png;点赞:03-good.png;掌声:04-applaud.png;666:05-666.png;小星星:06-star.png;钻石:07-diamond.png;跑车:08-car.png;火箭:09-rocket.png;前缀统一为://livestatic.videocc.net/uploaded/images/webapp/channel/donate/)
goodPrice
true
Double
道具打赏价格
goodEnabled
true
String
道具开关,值为 Y/N , Y为开启
返回对象描述
true代表设置成功,false代表设置失败
2、设置现金打赏
描述
调用约束
1、接口调用有频率限制,详细请查看,调用常见异常,详细请查看
2、带上频道号为设置频道现金打赏,不带频道号默认为全局现金打赏设置
单元测试
单元测试说明
1、请求正确,返回Boolean对象,B端依据此对象处理业务逻辑;
2、请求参数校验不合格,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败,失败字段 [pic不能为空 / msg不能为空] ]
3、服务器处理异常,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 保利威请求返回数据错误,请求流水号:66e7ad29fd04425a84c2b2b562d2025b,错误原因: invalid signature. ]
请求入参描述
channelId
false
String
频道号,不传为全局设置
cashes
true
Array
请求体参数,现金打赏数额数组,数组的长度必须为6
cashMin
true
Double
请求体参数,现金打赏自定义最小金额
enabled
false
String
请求体参数,现金打赏开关,不传默认开启,值为 Y/N , Y为开启
返回对象描述
true表示设置成功,false表示设置失败
3、查询打赏设置
描述
调用约束
1、接口调用有频率限制,详细请查看,调用常见异常,详细请查看
单元测试
单元测试说明
1、请求正确,返回LiveChannelDonateResponse对象,B端依据此对象处理业务逻辑;
2、请求参数校验不合格,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败,失败字段 [pic不能为空 / msg不能为空] ]
3、服务器处理异常,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 保利威请求返回数据错误,请求流水号:66e7ad29fd04425a84c2b2b562d2025b,错误原因: invalid signature. ]
请求入参描述
channelId
false
String
频道号,不传为获取全局设置
返回对象描述
globalSettingEnabled
String
是否应用全局设置,获取全局设置时,该值为null
donateCashEnabled
String
现金打赏开关
donateGoodEnabled
String
道具打赏开关
donateTips
String
打赏提示
cashes
Array
请求体参数,现金打赏数额数组,数组的长度必须为6
cashMin
Double
请求体参数,现金打赏自定义最小金额
goods
Array
goodName
String
道具名称,不能超过5个字符
goodImg
String
道具图片,不能超过120个字符(通过上传图片接口上传获取图片地址,或者使用默认地址;鲜花:01-flower.png;咖啡:02-coffee.png;点赞:03-good.png;掌声:04-applaud.png;666:05-666.png;小星星:06-star.png;钻石:07-diamond.png;跑车:08-car.png;火箭:09-rocket.png;前缀统一为://livestatic.videocc.net/uploaded/images/webapp/channel/donate/)
goodPrice
Double
道具打赏价格
goodEnabled
String
道具开关,值为 Y/N , Y为开启
4、设置频道微信分享信息
描述
调用约束
1、接口调用有频率限制,详细请查看,调用常见异常,详细请查看
单元测试
单元测试说明
1、请求正确,返回Boolean对象,B端依据此对象处理业务逻辑;
2、请求参数校验不合格,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败,失败字段 [pic不能为空 / msg不能为空] ]
3、服务器处理异常,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 保利威请求返回数据错误,请求流水号:66e7ad29fd04425a84c2b2b562d2025b,错误原因: invalid signature. ]
请求入参描述
channelId
true
String
频道号
wxShareTitle
false
String
微信分享的标题(30字符内)【对应api文档的weixinShareTitle字段】
wxShareDesc
false
String
微信分享的描述(120字符内)【对应api文档的weixinShareDesc字段】
返回对象描述
true为设置成功,false为设置失败
5、查询频道微信分享信息
描述
调用约束
1、接口调用有频率限制,详细请查看,调用常见异常,详细请查看
单元测试
单元测试说明
1、请求正确,返回LiveGetChannelWxShareResponse对象,B端依据此对象处理业务逻辑;
2、请求参数校验不合格,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败,失败字段 [pic不能为空 / msg不能为空] ]
3、服务器处理异常,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 保利威请求返回数据错误,请求流水号:66e7ad29fd04425a84c2b2b562d2025b,错误原因: invalid signature. ]
请求入参描述
channelId
true
String
频道号
返回对象描述
channelId
String
频道号
channelName
String
频道名称
coverImg
String
微信分享图标,即频道的直播图标
wxShareTitle
String
微信分享的标题【对应api文档的weixinShareTitle字段】
wxShareDesc
String
微信分享的描述【对应api文档的weixinShareDesc字段】
6、查询频道打赏设置
描述
调用约束
1、接口调用有频率限制,详细请查看,调用常见异常,详细请查看
单元测试
单元测试说明
1、请求正确,返回LiveGetChannelDonateResponse对象,B端依据此对象处理业务逻辑;
2、请求参数校验不合格,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败,失败字段 [pic不能为空 / msg不能为空] ]
3、服务器处理异常,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 保利威请求返回数据错误,请求流水号:66e7ad29fd04425a84c2b2b562d2025b,错误原因: invalid signature. ]
请求入参描述
channelId
true
String
频道号
返回对象描述
donateCashEnabled
String
现金红包打赏开关,Y:开启,N:关闭
cashDonate
ChannelCashDonate
donateGiftEnabled
String
礼物打赏开关,Y:开启,N:关闭
giftDonate
Array
cashes
Array
固定打赏金额,数组长度在1-6,最小值0.01,最大值9999.99【对应api文档的cashs字段】
cashMin
Float
自定义打赏金额-最低金额,最小值0.01,最大值9999.99
payWay
String
支付方式,CASH:现金支付,POINT:积分支付
cashUnit
String
现金单位
pointUnit
String
积分单位
cashPays
Array
pointPays
Array
name
String
礼物名称
img
String
礼物图片地址
price
Float
礼物价格
enabled
String
开关,Y:开启,N:关闭
name
String
礼物名称
img
String
礼物图片地址
price
Float
礼物价格
enabled
String
开关,Y:开启,N:关闭
7、修改频道礼物打赏设置
描述
调用约束
1、接口调用有频率限制,详细请查看,调用常见异常,详细请查看
单元测试
单元测试说明
1、请求正确,返回Boolean对象,B端依据此对象处理业务逻辑;
2、请求参数校验不合格,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败,失败字段 [pic不能为空 / msg不能为空] ]
3、服务器处理异常,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 保利威请求返回数据错误,请求流水号:66e7ad29fd04425a84c2b2b562d2025b,错误原因: invalid signature. ]
请求入参描述
channelId
true
String
频道号
donateGiftEnabled
false
String
礼物打赏开关,Y:开启,N:关闭
giftDonate
false
ChannelGiftDonate
payWay
false
String
支付方式,CASH:现金支付,POINT:积分支付
cashUnit
false
String
现金单位
pointUnit
false
String
积分单位
cashPays
false
Array
pointPays
false
Array
name
false
String
礼物名称
img
false
String
礼物图片地址
price
false
Float
礼物价格
enabled
false
String
开关,Y:开启,N:关闭
name
false
String
礼物名称
img
false
String
礼物图片地址
price
false
Float
礼物价格
enabled
false
String
开关,Y:开启,N:关闭
返回对象描述
修改频道礼物打赏设置返回实体
8、查询频道卡片推送
描述
调用约束
1、接口调用有频率限制,详细请查看,调用常见异常,详细请查看
单元测试
单元测试说明
1、请求正确,返回LiveGetChannelCardPushResponse对象,B端依据此对象处理业务逻辑;
2、请求参数校验不合格,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败,失败字段 [pic不能为空 / msg不能为空] ]
3、服务器处理异常,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 保利威请求返回数据错误,请求流水号:66e7ad29fd04425a84c2b2b562d2025b,错误原因: invalid signature. ]
请求入参描述
channelId
true
String
频道ID
返回对象描述
返回对象是List<LiveGetChannelCardPushResponse>,LiveGetChannelCardPushResponse具体元素内容如下:
id
Long
卡片推送主键ID
channelId
String
频道ID
title
String
卡片标题,最多16个字符
imageType
String
卡片样式类型,giftbox:礼物领取样式,redpack:红包样式
duration
Integer
卡片倒计时时长,取值:0,5,10,20,30,单位:秒,0为不显示倒计时时长
link
String
卡片跳转链接地址,带http://等协议头
pushEndTime
Date
推送结束时间
createdTime
Date
创建时间
lastModified
Date
修改时间
pushStatus
String
推送状态Y.推送中、N.未推送、L.上次推送
pushTime
Date
推送时间
enterEnabled
String
卡片入口Y.开启、N.关闭
showCondition
String
弹出方式,PUSH.推送后立即弹出、WATCH.观看后弹出
conditionValue
Integer
观看时长
conditionUnit
String
观看时长单位SECONDS.秒、MINUTES.分钟
countdownMsg
String
倒计时文案,showCondition为WATCH时生效,最多8个字符
9、创建频道卡片推送
描述
调用约束
1、接口调用有频率限制,详细请查看,调用常见异常,详细请查看
单元测试
单元测试说明
1、请求正确,返回LiveCreateChannelCardPushResponse对象,B端依据此对象处理业务逻辑;
2、请求参数校验不合格,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败,失败字段 [pic不能为空 / msg不能为空] ]
3、服务器处理异常,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 保利威请求返回数据错误,请求流水号:66e7ad29fd04425a84c2b2b562d2025b,错误原因: invalid signature. ]
请求入参描述
channelId
true
String
频道号
imageType
true
String
卡片样式类型,giftbox:礼物领取样式,redpack:红包样式
title
true
String
卡片标题,最多16个字符
link
true
String
卡片跳转链接地址,需要带http:等协议头
duration
true
Integer
卡片倒计时时长,取值:0,5,10,20,30,单位:秒,0为不显示倒计时时长
showCondition
true
String
弹出方式,PUSH:推送后立即弹出、WATCH:观看后弹出
conditionValue
false
Integer
观看后弹出的观看时长,showCondition为WATCH时生效
conditionUnit
false
String
观看后弹出的观看时长单位SECONDS.秒、MINUTES.分钟,showCondition为WATCH时,该值生效且必填
countdownMsg
false
String
倒计时文案,showCondition为WATCH时生效,最多8个字符
enterEnabled
true
String
卡片入口开关Y.开启、N.关闭
返回对象描述
id
Long
卡片推送主键ID
channelId
String
频道ID
title
String
卡片标题,最多16个字符
imageType
String
卡片样式类型,giftbox:礼物领取样式,redpack:红包样式
duration
Integer
卡片倒计时时长,取值:0,5,10,20,30,单位:秒,0为不显示倒计时时长
link
String
卡片跳转链接地址,带http:等协议头
pushEndTime
Date
推送结束时间
createdTime
Date
创建时间
lastModified
Date
修改时间
pushStatus
String
推送状态Y.推送中、N.未推送、L.上次推送
pushTime
Date
推送时间
enterEnabled
String
卡片入口Y.开启、N.关闭
showCondition
String
弹出方式,PUSH.推送后立即弹出、WATCH.观看后弹出
conditionValue
Integer
观看时长
conditionUnit
String
观看时长单位SECONDS.秒、MINUTES.分钟
countdownMsg
String
倒计时文案,showCondition为WATCH时生效,最多8个字符
10、修改频道卡片推送
描述
调用约束
1、接口调用有频率限制,详细请查看,调用常见异常,详细请查看
单元测试
单元测试说明
1、请求正确,返回Boolean对象,B端依据此对象处理业务逻辑;
2、请求参数校验不合格,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败,失败字段 [pic不能为空 / msg不能为空] ]
3、服务器处理异常,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 保利威请求返回数据错误,请求流水号:66e7ad29fd04425a84c2b2b562d2025b,错误原因: invalid signature. ]
请求入参描述
channelId
true
String
频道号
cardPushId
true
Long
卡片推送主键ID
imageType
false
String
卡片样式类型,giftbox:礼物领取样式,redpack:红包样式
title
false
String
卡片标题,最多16个字符
link
false
String
卡片跳转链接地址,需要带http:等协议头
duration
false
Integer
卡片倒计时时长,取值:0,5,10,20,30,单位:秒,0为不显示倒计时时长
showCondition
false
String
弹出方式,PUSH:推送后立即弹出、WATCH:观看后弹出
conditionValue
false
Integer
观看后弹出的观看时长,showCondition为WATCH时生效
conditionUnit
false
String
观看后弹出的观看时长单位SECONDS.秒、MINUTES.分钟,showCondition为WATCH时,该值生效且必填
countdownMsg
false
String
倒计时文案,showCondition为WATCH时生效,最多8个字符
enterEnabled
false
String
卡片入口开关Y.开启、N.关闭
返回对象描述
修改频道卡片推送返回实体
11、删除卡片推送
描述
调用约束
1、接口调用有频率限制,详细请查看,调用常见异常,详细请查看
单元测试
单元测试说明
1、请求正确,返回Boolean对象,B端依据此对象处理业务逻辑;
2、请求参数校验不合格,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败,失败字段 [pic不能为空 / msg不能为空] ]
3、服务器处理异常,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 保利威请求返回数据错误,请求流水号:66e7ad29fd04425a84c2b2b562d2025b,错误原因: invalid signature. ]
请求入参描述
channelId
true
String
频道号
cardPushId
true
Long
卡片推送主键ID
返回对象描述
删除卡片推送返回实体
12、推送频道卡片
描述
调用约束
1、接口调用有频率限制,详细请查看,调用常见异常,详细请查看
单元测试
单元测试说明
1、请求正确,返回Boolean对象,B端依据此对象处理业务逻辑;
2、请求参数校验不合格,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败,失败字段 [pic不能为空 / msg不能为空] ]
3、服务器处理异常,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 保利威请求返回数据错误,请求流水号:66e7ad29fd04425a84c2b2b562d2025b,错误原因: invalid signature. ]
请求入参描述
channelId
true
String
频道号
cardPushId
true
Long
卡片推送主键ID
返回对象描述
推送频道卡片返回实体
13、取消推送卡片
描述
调用约束
1、接口调用有频率限制,详细请查看,调用常见异常,详细请查看
单元测试
单元测试说明
1、请求正确,返回Boolean对象,B端依据此对象处理业务逻辑;
2、请求参数校验不合格,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败,失败字段 [pic不能为空 / msg不能为空] ]
3、服务器处理异常,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 保利威请求返回数据错误,请求流水号:66e7ad29fd04425a84c2b2b562d2025b,错误原因: invalid signature. ]
请求入参描述
channelId
true
String
频道号
cardPushId
true
Long
卡片推送主键ID
返回对象描述
取消推送卡片返回实体
14、查询频道微信分享信息
描述
调用约束
1、接口调用有频率限制,详细请查看,调用常见异常,详细请查看
单元测试
单元测试说明
1、请求正确,返回LiveGetChannelShareResponse对象,B端依据此对象处理业务逻辑;
2、请求参数校验不合格,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败,失败字段 [pic不能为空 / msg不能为空] ]
3、服务器处理异常,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 保利威请求返回数据错误,请求流水号:66e7ad29fd04425a84c2b2b562d2025b,错误原因: invalid signature. ]
请求入参描述
channelId
true
String
频道号
返回对象描述
shareBtnEnable
String
是否开启分享,Y:开启,N:关闭
titleType
String
标题类型follow直播标题、custom自定义
weixinShareTitle
String
分享标题,最大长度50,标题类型为custom时,该字段生效
weixinShareDesc
String
分享简介,最大长度120,标题类型为custom时,该字段生效
weixinShareCustomUrl
String
微信自定义分享地址,最大长度512
webShareCustomUrl
String
网页观看自定义分享地址,最大长度512
15、修改频道微信分享信息
描述
调用约束
1、接口调用有频率限制,详细请查看,调用常见异常,详细请查看
单元测试
单元测试说明
1、请求正确,返回Boolean对象,B端依据此对象处理业务逻辑;
2、请求参数校验不合格,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败,失败字段 [pic不能为空 / msg不能为空] ]
3、服务器处理异常,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 保利威请求返回数据错误,请求流水号:66e7ad29fd04425a84c2b2b562d2025b,错误原因: invalid signature. ]
请求入参描述
channelId
true
String
频道号
shareBtnEnable
true
String
是否开启分享,Y:开启,N:关闭
titleType
true
String
标题类型follow直播标题、custom自定义
weixinShareTitle
false
String
分享标题,最大长度50,标题类型为custom时,该字段必填
weixinShareDesc
false
String
分享简介,最大长度120,标题类型为custom时,该字段必填
weixinShareCustomUrl
false
String
微信自定义分享地址,最大长度512,链接必须带协议,如:https://,链接需要进行encode
webShareCustomUrl
false
String
网页观看自定义分享地址,最大长度512,链接必须带协议,如:https://,链接需要进行encode
返回对象描述
修改频道微信分享信息返回实体
Last updated
Was this helpful?