API详解
主要调用API
| API | 说明 | 返回内容 |
|---|---|---|
| CR_SDK.getUserinfo() | 获取当前用户信息 | CR_SDK.userinfo用户信息 |
| CR_SDK.getRoominfo() | 获取当前直播信息 | CR_SDK.roominfo直播信息 |
| CR_SDK.getUserPersonalMsg() | 获取点播信息方法 | 当页面需要展示点播功能时，需在初始化与初始化回调过程中获取该方法 |
| CR_SDK.dbEventBind(index) | 切换点播播放视频方法 | 需要传入点击的是第几个视频，传参index为num，初始为0 |
| CR_SDK.getAtuoImg() | 获取自定义图片相关信息 | 返回数据 data |
| CR_SDK.getAutoAd() | 获取自定义广告相关信息 | 返回数据 data |
| CR_SDK.getAutoMenu() | 获取自定义菜单相关信息 | 返回数据data.menuList,菜单列表 |
| CR_SDK.getAutoShare() | 获取自定义分享相关信息 | 返回数据 data |
| CR_SDK.joinLuckyMembers(name,phoneNum) | 抽奖报名方法 | 传入报名人的昵称及电话号码 |
| cr_create_div | 监听是否创建了 video 标签 | resCode为 0 时表示创建了video 标签 |
| cr_notify_live_type | 监听当前视频状态 | 1 直播状态 2 预告状态 3回放状态 4录播状态 6直播结束 7会议结束 8直播流结束 9后台设置直播结束 |
| CR_SDK.getOnLineNum() | 获取在线人数请求 | 返回在线人数cr_get_live_online_number |
| CR_SDK.sendChatMsg(chatinfo) | 发送评论信息 | 返回所需的评论信息字符串 |
| CR_SDK.sendQuest(questinfo) | 发送问题信息 | 返回提问信息字符串 |
| CR_SDK.getChats(count) | 获取历史聊天数据 | 返回历史聊天数据 回调方法cr_record_history_chat_msg |
| cr_record_history_QandA_msg | 获取历史问答信息 | 返回所有历史问答信息 |
| CR_SDK.setLiveAdmire(num) | 增加点赞次数 | num增加的点赞数 返回回调方法：cr_set_live_admire，返回code为0,设置成功 |
| CR_SDK.getDsInfo() | 红包，打赏，打赏排行榜相关信息开关 | 直接返回data |
| CR_SDK.payMoney(parms) | 发红包 | parms为一个json对象，openId: 微信的openId，optType:"REDPCK" ， totalNum: 红包个数， totalAmount: 发红包的总金额（分）， feeAmount:需要支付的金额（包含手续费，单位分）, remark :红包的祝福语，类似于恭喜发财， nickName :微信昵称，headerUrl：微信头像url 成功回调在聊天信息里，cr_receive_chat_msg |
| CR_SDK.talkRedBox(parms,callback) | 抢红包 | parms为json对象,openId ：微信openId，orderId：微信订单号， infor:祝福语，nickName：微信昵称，headerUrl：微信头像url callback:回调函数(result),RspCode：0，抢红包成功 6000，已经抢过此红包 5000，该红包被抢光。totalFee：抢到金额， headerUrl：发红包者的头像url，nickName：发红包着的昵称 |
| getWxGrabRedList(orderId) | 红包领取记录 | 回调函数：cr_get_WxGrabRed_List |
| CR_SDK.payMoney(parms) | 移动端打赏支付 | parms为一个json对象，openId: 微信的openId，optType:"FFDS" totalAmount: 打赏的总金额（分）, remark :打赏的祝福语，类似于恭喜发财， nickName :微信昵称，headerUrl：微信头像url。 成功回调在聊天信息里，cr_receive_chat_msg |
| CR_SDK.pcPayMoney(parms) | PC打赏扫码支付 | parms为一个json对象，optType:"PCDS",totalAmount:打赏金额（分）， remark:打赏祝福语，nickName:用户昵称 ，headerUrl:头像url。 回调函数：cr_check_paywatch_img，返回一个支付url |
| CR_SDK.getDsTopList(curPage,pageSize) | 打赏榜单列表 | 传参 curPage 第几页 pageSize 一页中加载多少条数据 成功回调函数 cr_check_dslist_img |
| CR_SDK.payMoney(parms) | 移动端送礼支付 | parms为一个json对象，openId: 微信的openId，optType:"FFSL totalAmount: 送礼的金额（分）,remark :送礼的信息， nickName :微信昵称，headerUrl：微信头像url。 成功回调在聊天信息里，cr_receive_chat_msg |
| CR_SDK.pcPayMoney(parms) | PC送礼扫码支付 | parms为一个json对象，optType:"PCSL",totalAmount:送礼金额（分）， remark:送礼信息，nickName:用户昵称 ，headerUrl:头像url。 回调函数：cr_check_paywatch_img，返回一个支付url |
| CR_SDK.sign_up_init() | 获取问卷内容 | 返回一组数据data |
| CR_SDK.sendMobileCodeAPI(parms) | 问卷发送验证码 | parms为一个json对象,LiveCode : 直播短连接 ，mobile: 手机号码 回调接口：cr_get_mobile_code |
| CR_SDK.getMobileCodeServlet(parms) | 问卷检测验证码 | 传参parms为一个json对象，mobile:手机号码，authCode:验证码 回调接口：cr_check_mobile_code_servlet |
| CR_SDK.liveSignUpServlet(parms) | 问卷提交验证信息 | 传参prams为json对象， LiveCode: 直播短连接，content: 一个个问题对象组成的数组, 如：contentList[i] = {"rowid": 问题id ,"content": 问题内容,"nickname":问题的名字 } 回调函数：cr_check_live_signup_servlet |
| CR_SDK.getWxPublic() | 获取公众号关注的信息 | 返回数据data，code:1，开启公众号关注功能，0则不开启。 wxPublicImg：微信公众号的图片，wxPublicName：微信公众号的名称 |
| CR_SDK.getWatchWay() | 获取权限观看的观看方式 | 返回数据data |
| CR_SDK.checkPwdPhoneYzm(parms) | 权限观看时校验密码或验证码 | 传参parms为一个json对象， LiveCode: 直播短连接， watchType: 观看方式， watchPhone:手机号码， watchCode: 密码或验证码 成功回调函数：cr_check_Live_Code |
| CR_SDK.getPhoneYzm(parms) | 手机号码观看，获取验证码 | 传参parms为一个json对象，LiveCode: 直播短连接， watchType:观看方式，watchPhone:手机号码 成功回调函数：cr_send_Phone_Code |
| CR_SDK.checkSendMoneyLook(openId) | 查询是否付费观看过 | openId:微信上是微信id，PC上是用户useid， 回调函数：cr_check_send_money_look |
| CR_SDK.remaintime() | 获取直播倒计时相关信息 | 返回data |
响应事件API
| API | 说明 |
|---|---|
| cr_init_callback | 初始化回调：resCode： 0为初始化成功，1为初始化失败，2为直播不存在 3昵称重复但仍初始化成功 4为超过最大并发数 |
| CR_SDK.getUserPersonalMsg() | 获取点播列表,返回data |
| CR_SDK.sendChatMsg(chatinfo) | 发送评论信息 |
| CR_SDK.sendQuest(questinfo) | 发送问题信息 |
| CR_SDK.getChats(count) | 获取历史聊天数据 回调事件：cr_record_history_chat_msg |
| cr_record_history_QandA_msg | 获取历史问答信息 |
| CR_SDK.getOnLineNum() | 获取在线观看人数 回调事件：cr_get_live_online_number |
| cr_user_leave_live | 监听用户离开 |
| cr_create_div | 监听是否创建了 video 标签 resCode为 0 时表示创建了video 标签 |
| cr_notify_live_type | 1 直播状态 ，2 预告状态， 3回放状态， 4录播状态 ，6直播结束， 7会议结束 ，8直播流结束 ，9后台设置直播结束 |
| cr_handle_all_chat_permission | 是否开启聊天，聊天权限变更通知 |
| cr_handle_chat_permission | 个人聊天权限变更 |
| cr_clear_all_chat | 清除所有聊天记录 |
| cr_get_del_im_sn | 删除某一条聊天信息 |
| cr_send_chat_msg_call | 发送信息回调 是否存在敏感词 |
| cr_receive_chat_msg | 接收聊天信息回调 |
| cr_receive_quesion_msg | 发送问题信息回调 |
| cr_receive_answer_msg | 监听接收问题信息回调 |
| cr_receive_bpublic_status | 监听问答信息公开状态回调 |
| cr_delete_all_ques | 删除所有问答信息 |
| cr_update_ques_answer_detail | 修改问题答案内容回调 |
| cr_set_broad_cast_ques | 监听问答开关状态回调 |
| cr_get_lucky_drawcfg_msg | 获取直播抽奖信息的回调方法 |
| cr_join_lucky_drawMembers_rslt | 抽奖报名的结果回调方法 |
| cr_get_lucky_draw_result | 开奖结果通知 |
| cr_notify_luckyd_draw_cfg | 当客户端设置了抽奖信息时，或者修改了配置的实时通知(开奖时间，是否自由开奖，奖品信息) |
| cr_get_live_admire | 初始化获取点赞总人数 |
| cr_notify_thumb_up | 点赞数量变化实时通知 |
| cr_notify_swtich_live_app_elements | 红包 打赏 打赏开关的通知 |
SDK全局变量
| 名称 | 类型 | 作用说明 |
|---|---|---|
| CR_SDK.isHideVideo | bool | 移动端使用的全局变量，默认为false,当直播开始了，SDK会创建一个video，因为移动端页面video的层级较高， 会影响在此之前的弹层，所以在弹层的时候如问卷，权限观看，发红包，打赏等功能弹层时，都要把该参数设置为true。弹层取消之后，再设置为false,再判断一下video是否存在，如果存在就可以$('#myVideo').show() |
SDK主要错误码
| 错误码 | 说明 |
|---|---|
| 800 | 会议不存在或已结束 |
| 900 | 包含敏感词 |
SDK调用方法注意事项
在主要调用API方法里面，如CR_SDK.getAtuoImg()，会直接返回数据，但有些方法需要监听接口,才可以获取数据，如下
CR_SDK.getOnLineNum() //发送请求
CR_SDK.on('cr_get_live_online_number', function(res){ //请求响应
}
这里需要注意的是可以多次调用请求，如CR_SDK.getOnLineNum()请求，但不建议在不同地方多次监听请求响应，如CR_SDK.on('cr_get_live_online_number', function(res){}；因为多个监听都会同时响应请求，最好在一个监听里区分每次不同的请求。