API参考
API
| 名称 | 参数 | 参数说明 | 描述 |
|---|---|---|---|
| initSDK | [Object] | {permision:{ id: 授权编号, key: 授权密钥 }, isShowLog:"是否显示打印"} |
初始化盟主sdk |
| initUser | [Object] | {uniqueId:"用户唯一ID", name:"用户名字"，avatar:"用户头像"} |
初始化用户信息 |
| toUpdateUserInfo | [Object] | {unique_id:"用户唯一ID", name:"用户名字"，avatar:"用户头像"} |
更新用户信息 |
| getTicketInfo | [Object] | {ticketId:"直播活动ID",uniqueId:"用户唯一ID"} |
获取直播间完整信息 |
| push | String | 聊天内容 | 发送消息 |
| connect | - | - | sdk初始化完成后，调用此方法，连接到当前直播会话中，与其它用户互动。 |
| disconnect | - | - | 断开连接，当用户退出时，调用此方法，结束直播会话。最好在页面的onload事件中调用 |
| getPraise | [Object] | {ticketId:活动编号, channelId:"频道编号", praises:点赞数, chatUid:会话id } |
点赞接口channelId |
| getGoods | [Object] | {ticketId:活动编号, type:"商品类型", offset:页码, limit:每页数量} |
获取商品列表接口 |
| getHistory | [Object] | {ticketId:活动编号, offset:页码, limit:每页数量, last_id:上一次请求的最后一条消息的id} |
获取历史信息接口 |
| getOnlines | [Object] | {ticketId:活动编号} |
获取在线人员列表 |
| getHostInfo | [Object] | {ticketId:活动编号} |
获取主播信息接口 |
| getWebinarToolsList | [Object] | {ticketId:活动编号} |
获取活动的所有配置开关 |
| checkPlayPermission | [Object] | {ticketId:活动编号, phone:手机号} |
检测当前活动的观看权限，白名单观看权限必须传phone，F码观看权限非必须 |
| useFCode | [Object] | {ticketId:活动编号, fCode:F码} |
当前活动的观看权限未F码观看时，使用F码进行权限验证 |
| getLiveInfoOfChannel | [Object] | {channelId:频道编号} |
获取当前频道是否有正在直播的活动 |
| createNewLive | [Object] | {liveCover:"活动封面"，liveName:"活动名字"，liveIntroduction:"活动简介"，auto_record:"是否生成回放"，channelId:"频道编号"，live_style:"横屏还是竖屏，0-横屏，1-竖屏"，live_type:"语音还是视频直播，0-视频直播 1-语音直播"，view_mode:"观看方式 1-免费，5-白名单， 6-F码"，category_id:"分组ID"，pay_notice:"使用白名单观看权限的提示文案"，white_id:"使用白名单观看权限的白名单列表ID"，fcode_id:"使用F码观看权限的F码ID"} |
创建直播活动 |
| getCategoryList | [] | {} |
获取分组列表，创建活动时需要，非必须 |
| getFCodeList | [] | {} |
获取F码列表，创建活动时需要，非必须 |
| getWhiteList | [] | {} |
获取白名单列表，创建活动时需要，非必须 |
| startLive | [Object] | {ticketId:"活动编号"，live_tk:"活动凭证"，uniqueId:"用户唯一ID"，name:"用户名字"，avatar:"用户头像"} |
获取推流地址，开始直播 |
| stopLive | [Object] | {channelId:"频道编号"，ticketId:"活动编号"} |
结束直播，获取结束直播信息 |
| blockTicket | [Object] | {channelId:"频道编号"，ticketId:"活动编号",isChat:"是否禁言，0-禁言，1-解除禁言"} |
聊天室设置是否禁言 |
| mzee | - | - | 事件处理对象(见表2.1) |
| getDocumentList(channel_id , ticketId) | [Object] | channel_id 频道编号 ticketId 活动编号 |
获取直播关联的文档列表 |
| getDocumentInfo(channel_id , ticketId , document_id) | {Object} | channel_id 频道编号 ticketId 活动编号 document_id 文档id |
获取文档详情 |
| getChannelVote(ticketId) | {Object} | ticketId 活动编号 | 获取投票详情数据 |
| getVoteOptions(id) | [Object] | id 投票id | 获取投票数据列表 |
| postVote(id , option_id , ticket_id) | - | id 投票ID option_id 投票活动选项ID ticket_id 活动id |
提交投票选项 |
| getAQList(ticket_id , is_new_reply , offset , limit) | [Object] | ticket_id 活动id is_new_reply 是否查询最新未读回复 0:否 1:是 offset 分页 limit 条数 |
获取问答列表 |
| postQuestion(ticket_id , content , is_anonymous) | - | ticket_id 活动id content 提问内容 is_anonymous 是否匿名提问 0:否 1:是 |
提交问答 |
| getAdvertScreen({ticketId}) | {Object} | {ticketId:活动编号} |
获取暖场图 |
| getAdvertRolling({ticketId}) | [Object] | {ticketId:活动编号} |
获取活动的滚动广告 |
| getADInfo(ticket_id) | {Object} | {ticketId:活动编号} |
获取配置的片头视频信息 |
| getGiftList(ticket_id , offset, limit) | [Object] | ticket_id 活动id offset 分页 limit 条数 |
获取自定义礼物列表 |
| pushGift(ticket_id , gift_id, quantity) | - | ticket_id 活动id gift_id 礼物id quantity 个数 |
发送礼物 |
2.1 事件处理对象列表
| 事件名称 | 接收参数 | 描述 |
|---|---|---|
| msg | [Object] | 接收其它用户发送的消息和发送消息的用户信息 |
| online | [Object] | 其他用户上线时通知 |
| offline | [Object] | 其他用户下线时通知 |
| complete | [Object] | 监听推送消息(见表2.1.1) |
| cmd | [Object] | 监听控制台消息(见表2.1.2) |
| channel | [Object] | 监听频道消息(见表2.1.3) |
2.1.1 complete监听推送消息
监听返回信息res的date.type类型[res.data.type]
| 类型 | 描述 |
|---|---|
| gift | 收到礼物消息 |
| ... | 更多回调可参考demo |
2.1.2 cmd监听控制台消息
监听返回信息res的date.type类型[res.data.type]
| 类型 | 描述 |
|---|---|
| *over | 直播推流暂停 |
| *liveEnd | 直播结束 |
| *publishStart | 开始直播 |
| *channelStart | 所属频道有新的活动开始直播了 |
| *disablechat | 收到一条禁言消息 |
| *permitchat | 收到一条解禁消息 |
| *webinarViewConfigUpdate | 活动直播中的营销和控制开关 |
| *kickout | 收到一条踢出用户的消息 |
| *answerNewReplyMsg | 我的问题收到一条新回复 |
| *docSwitchPage | 直播中管理员切换了文档 |
| ... | 更多回调可参考demo |
2.1.3 channel监听频道消息
监听返回信息res的date.type类型[res.data.type]
| 类型 | 描述 |
|---|---|
| uv | 直播观看人数 |