修改频道卡片推送
Last updated
Was this helpful?
Last updated
Was this helpful?
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,
2、非必选的请求参数,如果不传则使用默认项,关联关系除外(如:conditionUnit字段在showCondition为WATCH时,需必填)
appId
true
String
timestamp
true
Long
当前13位毫秒级时间戳,3分钟内有效
sign
true
String
channelId
true
String
频道号
cardPushId
true
Long
卡片推送主键ID
imageType
false
String
卡片样式类型 giftbox:礼物领取样式 redpack:红包样式 custom:自定义
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:关闭
linkEnabled
false
String
卡片跳转开关 Y:开启 N:关闭
redirectType
false
String
跳转方式 iframe:页内显示 tab:新开页面
enterImage
false
String
卡片入口图片
cardImage
false
String
卡片图片
请求体参数:
code
Integer
响应状态码,200为成功返回,非200为失败
status
String
响应结果,由业务决定,成功返回success,失败返回error
success
Boolean
响应结果,由业务决定,成功返回true,失败返回false
data
Object
成功响应时返回null
error
Object
requestId
String
请求ID,每次请求生成的唯一的 UUID,仅可用于排查、调试,不应该和业务挂上钩
code
Integer
错误代码,用于确定具体的错误原因
desc
String
错误描述,与 error.code 对应
成功示例
异常示例
账号appId【详见】
签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据
【详见】
状态码非200时的错误信息【详见】
快速接入基础代码请下载相关依赖源码, ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。
强烈建议您使用完成API的功能对接,直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。