1、创建研讨会频道(旧版后台)
创建频道并进行相关设置
接口地址(仅做说明使用):https://api.polyv.net/live/v3/channel/basic/create
1、接口调用有频率限制,详细请查看,调用常见异常,详细请查看
@Test
public void testCreateChannel() throws IOException, NoSuchAlgorithmException {
SeminarCreateChannelRequest seminarCreateChannelRequest = new SeminarCreateChannelRequest();
SeminarCreateChannelResponse seminarCreateChannelResponse;
try {
SeminarCreateChannelRequest.BasicSetting basicSetting = new SeminarCreateChannelRequest.BasicSetting();
basicSetting.setName("测试SDK创建研讨会")
.setChannelPasswd(super.getRandomString(6))
.setCategoryId(super.getCategory());
SeminarCreateChannelRequest.AuthSetting authSetting = new SeminarCreateChannelRequest.AuthSetting();
authSetting.setRank(1)
.setEnabled(SeminarConstant.Flag.YES.getFlag())
.setAuthType(SeminarConstant.AuthType.CODE.getCode())
.setAuthCode("123");
seminarCreateChannelRequest.setBasicSetting(basicSetting).setAuthSettings(Arrays.asList(authSetting));
seminarCreateChannelResponse = new SeminarChannelServiceImpl().createChannel(seminarCreateChannelRequest);
Assert.assertNotNull(seminarCreateChannelResponse);
if (seminarCreateChannelResponse != null) {
//to do something ......
log.debug("测试创建研讨会频道(旧版后台)成功 {}", JSON.toJSONString(seminarCreateChannelResponse));
//TODO 此处创建完成后删除了频道,正式使用需删除该语句
super.deleteChannel(seminarCreateChannelResponse.getChannelId());
}
} catch (PloyvSdkException e) {
//参数校验不合格 或者 请求服务器端500错误,错误信息见PloyvSdkException.getMessage()
log.error(e.getMessage(), e);
// 异常返回做B端异常的业务逻辑,记录log 或者 上报到ETL 或者回滚事务
throw e;
} catch (Exception e) {
log.error("SDK调用异常", e);
throw e;
}
}
1、请求正确,返回SeminarCreateChannelResponse对象,B端依据此对象处理业务逻辑;
2、请求参数校验不合格,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败,失败字段 [pic不能为空 / msg不能为空] ]
3、服务器处理异常,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 保利威请求返回数据错误,请求流水号:66e7ad29fd04425a84c2b2b562d2025b,错误原因: invalid signature. ]
BasicSetting参数描述
频道密码,(可以通过频道号+频道密码登录该频道)长度不能超过16位,必须同时包含字母和数字
新建频道的所属分类,如果不提交,则为默认分类(分类ID可通过“查询直播分类”接口得到)
子账号邮箱,填写时频道会创建在该子账号下(子账号不能被删除或者禁用),暂无法通过接口获取
AuthSetting参数描述
pay:付费观看 code:验证码观看 phone:白名单观看 info:登记观看 custom:自定义授权观看 external:外部授权观看 direct:独立授权观看
当authType为pay时,设置参数,必填。欢迎语标题
当authType为pay时,设置参数,必填。价格,单位为元
当authType为pay时,设置参数,非必填。付费有效截止日期
当authType为pay时,设置参数,非必填。付费有效时长,单位天。当watchEndTime和validTimePeriod都为空时,表示付费永久有效
当authType为code时,设置参数,必填。验证码
当authType为code时,设置参数,非必填。提示文案
当authType为code时,设置参数,非必填。公众号二维码地址
当authType为phone时,设置参数,非必填。提示文案
当authType为external时,设置参数,必填。SecretKey
当authType为external时,设置参数,必填。自定义url
当authType为external时,设置参数,非必填。跳转地址
当authType为custom时,设置参数,必填。SecretKey
当authType为custom时,设置参数,必填。自定义url
当authType为direct时,设置参数,必填。独立授权SecretKey
InfoField参数描述
登记类型,姓名-name,文本-text,手机号码-mobile,数字-number,下拉选项-option,登记观看时该字段必填
下拉选项时,下拉的选项值,以英文逗号分割。选项个数上限为8个;选项内容最多为8字符
POLYV用户ID,和保利威官网一致,获取路径:官网->登录->直播(开发设置)
2、创建研讨会频道(新版后台)
1、接口调用有频率限制,详细请查看,调用常见异常,详细请查看
1、请求正确,返回SeminarCreateChannelV2Response对象,B端依据此对象处理业务逻辑;
2、请求参数校验不合格,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败,失败字段 [pic不能为空 / msg不能为空] ]
3、服务器处理异常,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 保利威请求返回数据错误,请求流水号:66e7ad29fd04425a84c2b2b562d2025b,错误原因: invalid signature. ]
研讨会主持人密码,仅直播场景是研讨会时有效,长度6-16位,不传则由系统随机生成。研讨会主持人密码和参会人密码不能相同。
研讨会参会人密码,仅直播场景是研讨会时有效,长度6-16位,不传则由系统随机生成。研讨会主持人密码和参会人密码不能相同。
子账号邮箱,填写时频道会创建在该子账号下(子账号不能被删除或者禁用),暂无法通过接口获取
POLYV用户ID,和保利威官网一致,获取路径:官网->登录->直播(开发设置)
研讨会主持人密码,仅直播场景是研讨会时不为null,长度6-16位
研讨会参会人密码,仅直播场景是研讨会时不为null,长度6-16位
1、接口调用有频率限制,详细请查看,调用常见异常,详细请查看
1、请求正确,返回SeminarGetRecordSettingResponse对象,B端依据此对象处理业务逻辑;
2、请求参数校验不合格,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败,失败字段 [pic不能为空 / msg不能为空] ]
3、服务器处理异常,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 保利威请求返回数据错误,请求流水号:66e7ad29fd04425a84c2b2b562d2025b,错误原因: invalid signature. ]
POLYV用户ID,通过注册保利威官网获取,路径:官网->登录->直播(开发设置)
1、接口调用有频率限制,详细请查看,调用常见异常,详细请查看
1、请求正确,返回Boolean对象,B端依据此对象处理业务逻辑;
2、请求参数校验不合格,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败,失败字段 [pic不能为空 / msg不能为空] ]
3、服务器处理异常,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 保利威请求返回数据错误,请求流水号:66e7ad29fd04425a84c2b2b562d2025b,错误原因: invalid signature. ]
修改研讨会频道录制设置返回实体
5、获取研讨会直播间参会者统计数据
1、接口调用有频率限制,详细请查看,调用常见异常,详细请查看
1、请求正确,返回SeminarGetViewLogResponse对象,B端依据此对象处理业务逻辑;
2、请求参数校验不合格,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败,失败字段 [pic不能为空 / msg不能为空] ]
3、服务器处理异常,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 保利威请求返回数据错误,请求流水号:66e7ad29fd04425a84c2b2b562d2025b,错误原因: invalid signature. ]
页数,默认为1【对应api文档的pageNumber字段】
当前页【对应api文档的pageNumber字段】
总页数【对应api文档的totalPages字段】
ViewLog参数描述
1、接口调用有频率限制,详细请查看,调用常见异常,详细请查看
1、请求正确,返回SeminarGetCdnViewLogResponse对象,B端依据此对象处理业务逻辑;
2、请求参数校验不合格,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败,失败字段 [pic不能为空 / msg不能为空] ]
3、服务器处理异常,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 保利威请求返回数据错误,请求流水号:66e7ad29fd04425a84c2b2b562d2025b,错误原因: invalid signature. ]
结束时间(只能查询开始时间所在当月的数据;如需跨月查询,请分开请求查询)
页数,默认为1【对应api文档的pageNumber字段】
当前页【对应api文档的pageNumber字段】
总页数【对应api文档的totalPages字段】
ViewLog参数描述
观看类型 vod:回放; live:直播【对应api文档的param3字段】
1、接口调用有频率限制,详细请查看,调用常见异常,详细请查看
1、请求正确,返回Boolean对象,B端依据此对象处理业务逻辑;
2、请求参数校验不合格,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败,失败字段 [pic不能为空 / msg不能为空] ]
3、服务器处理异常,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 保利威请求返回数据错误,请求流水号:66e7ad29fd04425a84c2b2b562d2025b,错误原因: invalid signature. ]
POLYV用户ID,和保利威官网一致,获取路径:官网->登录->直播(开发设置)
删除单个频道返回实体
1、接口调用有频率限制,详细请查看,调用常见异常,详细请查看
1、请求正确,返回Boolean对象,B端依据此对象处理业务逻辑;
2、请求参数校验不合格,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败,失败字段 [pic不能为空 / msg不能为空] ]
3、服务器处理异常,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 保利威请求返回数据错误,请求流水号:66e7ad29fd04425a84c2b2b562d2025b,错误原因: invalid signature. ]
请求体参数,频道号列表,每次最多删除100个频道, 必须放在请求体中
批量删除频道返回实体
1、接口调用有频率限制,详细请查看,调用常见异常,详细请查看
1、请求正确,返回SeminarGetLiveTypeResponse对象,B端依据此对象处理业务逻辑;
2、请求参数校验不合格,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败,失败字段 [pic不能为空 / msg不能为空] ]
3、服务器处理异常,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 保利威请求返回数据错误,请求流水号:66e7ad29fd04425a84c2b2b562d2025b,错误原因: invalid signature. ]
会议类型 private 对内研讨(默认) public 对外直播
1、接口调用有频率限制,详细请查看,调用常见异常,详细请查看
1、请求正确,返回Boolean对象,B端依据此对象处理业务逻辑;
2、请求参数校验不合格,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败,失败字段 [pic不能为空 / msg不能为空] ]
3、服务器处理异常,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 保利威请求返回数据错误,请求流水号:66e7ad29fd04425a84c2b2b562d2025b,错误原因: invalid signature. ]
会议类型 private 对内研讨 public 对外直播
修改研讨会会议类型返回实体