以下提到的account为接入方主播账号或ID或手机号等，每个主播需具有独立唯一的account标识（注意：这个account不是欢拓后台的主播ID）
添加直播
api名称：course.add，SDK对应方法：courseAdd
应用参数说明:| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| course_name | string | Y | 直播名称 |
| account | string | Y | 接入方主播账号或ID或手机号等，最长32位 |
| start_time | string | Y | 直播开始时间,格式: 2015-01-10 12:00:00 |
| end_time | string | Y | 直播结束时间,格式: 2015-01-10 13:00:00 |
| nickname | string | Y | 主播的昵称 |
| accountIntro | string | N | 主播的简介 |
| options | object | N | 其他选项 |
| departmentId 部门id，设置直播所属部门 | |||
| robotNumber 虚拟用户数量；robotType 虚拟用户昵称类型：0使用真实姓名，1使用网络昵称；adminNotShow 老师与助教是否显示虚拟用户：1不显示，0显示 | |||
| setDefault 是否将本次直播配置设为该主播的默认配置：1 设为该主播的默认配置，不设置为默认则不传 | |||
| password 主播密码，只有新主播生效。已经存在的主播，密码不会被修改 | |||
| scenes。直播类型。1: 教育直播，2: 生活直播。默认 1 |
options示例：{"departmentId":123,"barrage":1}
返回data参数说明：| 名称 | 类型 | 描述 |
|---|---|---|
| partner_id | int | 合作方id |
| bid | int | 欢拓系统的主播id |
| course_name | string | 直播名称 |
| start_time | int | 开始时间戳 |
| end_time | int | 结束时间戳 |
| zhubo_key | string | 主播登录秘钥 |
| admin_key | string | 客服登录秘钥 |
| user_key | string | 观众登录秘钥 |
| add_time | int | 直播创建时间 |
| course_id | int | 直播id |
更新直播信息
api名称：course.update，SDK对应方法courseUpdate
应用参数说明:| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| course_id | int | Y | 直播id |
| account | String | Y | 接入方主播账号或ID或手机号等 |
| course_name | String | Y | 直播名称 |
| start_time | int | Y | 直播开始时间,格式: 2015-01-10 12:00:00 |
| end_time | int | Y | 直播结束时间,格式: 2015-01-10 13:00:00 |
| nickname | string | Y | 主播的昵称 |
| accountIntro | string | N | 主播的简介 |
| options | object | N | 其它可选参数 |
| robotNumber 虚拟用户数量；robotType 虚拟用户昵称类型：0使用真实姓名，1使用网络昵称 |
options 示例：{"barrage":1}
返回参数说明：code=0为成功，其他值为失败删除直播信息
api名称：course.delete，SDK对应方法：courseDelete
- 应用参数说明:
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| course_id | int | Y | 直播id |
- 返回参数说明：code=0为成功，其他值为失败
获取直播配置信息
api名称：course.getConfig，SDK对应方法：courseConfig
- 应用参数说明：
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| course_id | string | Y | 直播ID |
返回data参数说明：| 名称 | 类型 | 描述 |
|---|---|---|
| robot | array | robot.number为虚拟用户数量，robot.type为虚拟用户类型(0虚拟用户使用真实姓名，1虚拟用户使用网络昵称)，robot.adminNotShow为老师与助教是否显示虚拟用户(1为不显示，0为显示) |
| playbackMode | int | 是否开启课程回放模式，默认开启，0:关闭，1:开启 |
更新直播配置信息
api名称：course.updateConfig，SDK对应方法：courseUpdateConfig
- 应用参数说明：
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| course_id | string | Y | 直播ID |
| options | array | Y | 配置参数 |
options参数说明:
示例：{"barrage":1}| 名称 | 类型 | 必须 | 描述 |
|---|---|---|---|
| barrage | int | N | 弹幕是否开启，0、关闭，1、开启 |
| robotEnable | int | N | 虚拟用户是否开启，0、关闭，1、开启 |
| robotNumber | int | N | 虚拟用户数量 |
| robotType | int | N | 虚拟用户类型，0、虚拟用户使用真实姓名，1、虚拟用户使用网络昵称 |
| adminNotShow | int | N | 老师与助教不显示虚拟用户，1、不显示，0、显示 |
| robotChat | int | N | 虚拟用户发言，0、关闭 ，1、开启 |
| setDefault | int | N | 传入1将此课程配置设为该主播的默认配置，不设置为默认则不传 |
| modetype | int | N | 课程模式，1、语音云，3、大班(默认)，5、小班,，6、大班互动 |
| playbackMode | int | N | 课程回放， 0、关闭，1、开启，默认开启 |
| theftproofEnable | int | N | 防盗录是否开启，0关闭，1开启 |
| watermarkEnable | int | N | 视频水印是否开启，0关闭，1开启 |
| watermarkType | int | N | 视频水印类型，0图片水印，1文字水印 |
| watermarkFile | file | N | 视频水印文件（限制为宽200，高75，文件大小为1M） |
| watermarkText | string | N | 视频水印文字水印，字数限制10 |
| watermarkLocation | int | N | 视频水印位置，0、左上角，1、右上角，2、左下角，3、右下角 |
返回参数说明：code=0为成功，其他值为失败虚拟用户导入
api名称：course.robot.set，SDK对应方法：courseRobotSet
多次设置，后面的会覆盖前面的设置
- 应用参数说明：
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| course_id | string | Y | 直播ID |
| userList | array | Y | 虚拟用户列表，二维数组，示例：[{"nickname":"xxx","avatar":"http://static-1.talk-fun.com/open/cooperation/default/live-pc/css/img/main/user.png"},{"nickname":"yyy","avatar":"http://static-1.talk-fun.com/open/cooperation/default/live-pc/css/img/main/user.png"}]，nickname为用户昵称，avatar为头像，总数不能超过100个 |
| total | int | N | 虚拟用户总数量，不能超过10000(可以比userList多，但用户列表默认只显示100个用户，userList限制了100个) |
返回参数说明：code=0为成功，其他值为失败获取直播PPT章节信息
api名称：course.chapter.list，SDK对应方法：courseChapterList
- 应用参数说明：
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| course_id | int | Y | 直播ID |
返回data参数说明：| 名称 | 类型 | 描述 |
|---|---|---|
| name | string | 章节名称 |
| time | float | 章节时间（相对直播开始的时间） |
| ppt | string | ppt图片URL |
| page | int | PPT页码 |
修改生活直播相关配置
api名称：course.updateLifeConfig，SDK对应方法：updateLifeConfig
- 应用参数说明：
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| course_id | string | Y | 直播ID |
| options | object | N | 首次设置并未选的，那么使用默认设置(如界面模式默认全屏模式)，更多请查看直播管理-设置。 |
| pageViewMode 界面模式 1全屏模式 0二分屏 2课件模式 3三分屏 | |||
| background 直播间背景图，全屏模式时使用；background.enable是否选择开启直播背景图，0未开启 1开启；当选择开启时，background.url直播间背景图必传；示例：{"enable":1"url":""} | |||
| intro 直播引导图，二分屏时使用，推荐使用宽高比例为16:9的jpg、jpeg、png图片文件大小不超过2M；intro.url引导图链接；示例：{"url":""} | |||
| banner 广告条，最多可添加5条广告，二分屏模式时使用，最多可添加5个；banner.enable是否选择开启广告条，0未选择 1选择；banner.data广告条数组；banner.data.type 类型1链接地址 2拨打电话；banner.data.tel 电话；banner.data.link 链接地址；banner.data.imgurl 手机端广告图链接地址；banner.data.pcImgurl pc端广告图链接地址；示例：{"enable":1,"data":[{"type":1,"tel":"","link":"","imgurl":"","pcImgurl":""}]} | |||
| focus 关注按钮；focus.enable 是否选择关注按钮 0否 1是；focus.data.popUp 进入直播间自动弹出公众号二维码 0否 1是；focus.data.url 公众号二维码，jpg、jpeg、png图片文件大小不超过2M；示例：{"enable":"1","data":{"popUp":"1","url":""}} | |||
| number 观看人数开关；number.enable 是否开启 观看人数 0否 1是；示例：{"enable":"1"} | |||
| invitationList 邀请榜单开关，观众可以生成专属的邀请卡；invitationList.enable 是否开启 0否 1是；示例：{"enable":"1"} | |||
| countDown 直播倒计时开关；countDown.enable 是否开启 0否 1是；示例：{"enable":"1"} | |||
| store 商城； store.enable是否开启 0未开启 1开启，store.type 1商品列表,2商城链接,3商城二维码；store.data.url 存储商城链接；store.data.qrcode 商城二维码；示例：{"enable":1,"type":"1","data":{"url":"","qrcode":""}} | |||
| reward 打赏主播开关；reward.enable 是否开启 0否 1是；示例：{"enable":"1"} | |||
| inviteRanking 邀请观看开关；inviteRanking.enable 是否开启 0否 1是；示例：{"enable":"1"} | |||
| redPack 发红包开关；redPack.enable 是否开启 0否 1是；示例：{"enable":"1"} | |||
| like 点赞开关；like.enable 0否 1是；示例：{"enable":"1"} | |||
| more 更多入口；more.redPackRecord 红包记录开关 0否 1是；more.withdraw 提现开关 0否 1是；more.store 商城入口开关，more.store.enable 是否开启 0否 1是，more.store.url 商城入口链接；more.info 个人中心开关 0否 1是；more.liveLine 切换线路开关 0否 1是；more.report 举报开关 0否 1是；示例：{"redPackRecord":0,"withdraw":0,"store":{"enable":1,"url":""},"info":1,"liveLine":1,"report":1} | |||
| service 客服私聊开关 ;service.enable 0否 1是；示例：{"enable":"1"} | |||
| menu 菜单入口开关，最多可添加8个菜单，开启请设置menuList；menu.enable 是否开启 0否 1是；示例：{"enable":"1"} | |||
| chatTime 聊天时间开关；chatTime.enable 是否开启 0否 1是；示例：{"enable":"1"} | |||
| entranceTips 入场提示开关；entranceTips.enable 是否开启 0否 1是；示例：{"enable":"1"} | |||
| menuList 菜单设置；应保证每个菜单有以下字段: title, type, content。分别表示: 菜单名称, 菜单类型，自定义图文内容；菜单类型分为 chat聊天 editor自定义图文 invite邀请榜单 courseware课件；示例：[{"title":"聊天","type":"chat","content":""}] | |||
| share 分享设置；share.title 分享标题设置，share.title.type 标题类型 1默认当场直播名称 2固定标题， share.title.value 固定标题值；share.description.value 描述；share.img.value 图标url；示例：{"title":{"type":"1","value":""},"description":{"value":"视频内容不错哟，分享给你，我们一起看看吧"},"img":{"value":""}} | |||
| popUp 弹窗列表(覆盖式更新,有推送中的弹窗不能更新，最多添加5条记录) ; 应保证每个菜单有以下字段: uuid,img, title, url, type, duration。uuid：弹窗唯一id,传空时欢拓生成；img：广告图链接 (广告图最大宽高为:576px*1000px,不超2M,格式：GIF/PNG/JPG); title: 主题 (32字长)；url：链接地址（微信小程序链接前加上[wx]；type：推送类型 1手动推送 2进入直播间时推送；duration：展示时长 (范围3-15秒); 示例：[{"uuid":"xxx"."img":"xxx.jpg","title":"xxx","url":"xxx.com",type:1,"duration":3}] popUpPush 推送; uuid:弹窗id，status 0取消推送， 1推送 ，默认为0; 示例: {"uuid":"xxx","status":1} uuid:弹窗唯一id； |
|||
| ad 浮动广告开关(只能在全屏模式下使用)，ad.enable 0未开启 1开启 adlist 浮动广告 覆盖式更新，最多5条记录，应保证每个菜单有以下字段:img, position.top, position.left, scale, link 分别表示：广告图(最大宽为:420px,不超2M,格式JPG/PNG)，居上(%)，居左(%)，大小(%); 示例eg: [{"img":"xxx.jpg","position":{"top":0,"left":100},"scale":30,"link":""}] |
|||
| goodsPrompt 商品点击提示；goodsPrompt.enable 0未开启 1开启； goodsPrompt.data 商品点击提示数组；goodsPrompt.data.type 类型 1单独展示 2聊天区展示；goodsPrompt.data.goto 点击信息跳转到对应商品页面 0否 1是；goodsPrompt.data.style 展示样式 1样式一 2样式二；goodsPrompt.data.title 通知标题；goodsPrompt.data.button 按钮文案；goodsPrompt.data.status 参与状态；示例: {"enable":"1","data":{"type":"1", "goto": "0", "style": "1", "title":"热卖", "button":"立即抢购", "status":"下单"}} |
|||
| popUpSwitch 宣传图入口；popUpSwitch.enable 0未开启 1开启；popUpSwitch.data.image 入口图标链接，图片尺寸建议像素为74*74，不得超过2M 格式支持JPG、PNG、JPEG；popUpSwitch.data.name 入口名称，字数最多4个；popUpSwitch.data.title 弹窗标题，字数最多10个；popUpSwitch.playback 回放弹窗 0未开启 1开启，回放可自动推送直播时的宣传图弹窗；示例：{"enable":"0","data":{"image":"xxx.png","name":"宣传图","title":"宣传图列表"},"playback":"0"} | |||
| userPopUp 观众点击提示，观众点击宣传图后，直播间所有人将显示通知；userPopUp.enable 0未开启 1开启；userPopUp.data.title 通知标题，字数最多15个；userPopUp.data.button 按钮文案，字数最多3个；userPopUp.data.joined 参与状态，字数最多3个；示例：{"enable":"1","data":{"title":"通知标题","button":"查看","joined":"已参与"}} |
返回参数说明：code=0为成功，其他值为失败