第三方互动工具交互接口文档

概述

默认每个接口都可以传入success和fail字段,代表接口调用成功和失败的回调,在startInteraction接口里举例,传参如下:

{ uuid, //开发者应用方生成的针对每一次互动的id typeId, //互动工具类型id isFloatWindow, //是否以浮窗形式响应互动(可选,默认false) pcParam, //可选,PC互动工具窗口参数 mobileParam, //可选,mobile互动工具窗口参数 success:function(res){}, //成功回调 fail:function(res){}, //失败回调}

startInteraction

方法名 调用端 类型 说明 PC(MAC) Android Ios 直播间web
startInteraction js 异步 开启互动, 通知参会人该互动开启 × × ×
  • 参数
{ uuid: string, //开发者应用方生成的针对每一次互动的id typeId: number, //互动工具类型id isFloatWindow: boolean, //是否以浮窗形式响应互动(可选,默认false) pcParam: { width: number, // 可选,窗口宽度 height: number, // 可选,窗口高度 position: string, // 可选,窗口对齐方式,可选值:'center','bottom' }, // 可选,PC互动工具窗口参数 mobileParam: { horizontal: { width: number, // 可选,窗口宽度,百分比小数表示,0到1 height: number, // 可选,窗口高度,百分比小数表示,0到1 position: string, // 可选,窗口对齐方式,可选值:'center','bottom' }, // 可选,横屏参数 vertical: { width: number, // 可选,窗口宽度,百分比表示,0到1 height: number, // 可选,窗口高度,百分比表示,0到1 position: string, // 可选,窗口对齐方式,可选值:'center','bottom' }, // 可选,竖屏参数 }, // 可选,mobile互动工具窗口参数}
  • 返回值
{ code:200, msg:''}

endInteraction

方法名 调用端 类型 说明 PC(MAC) Android Ios 直播间web
endInteraction js 异步 结束互动, 通知参会人该互动结束 × × ×
  • 参数
{ uuid: string, //开发者应用方生成的针对每一次互动的id}
  • 返回值
{ code:200, msg:''}

getMeetingInfo

方法名 调用端 类型 说明 PC(MAC) Android Ios 直播间web
getMeetingInfo js 异步 获取当前会议的会议信息
  • 参数
  • 返回值
{ code:200, data: { conferenceJoinUrl: string;//会议链接 confName: string; //会议名称 confHostName: string; //主持人名称 startTime: Date;//会议开始时间 endTime: Date;//会议结束时间 tempConferenceId: string, // 临时会议id conferenceId: string, // 会议id customerCode: string, // 客户编号 btplConfRoles: [ // 为兼容各种类型的活动,当活动是非专业活动(不带模板),标准活动的角色( 1:主持人(管理者) 2: 联席主持人(辅助管理者) 3: 嘉宾(普通参会人) 4: 观众(普通参会人)) { roleId: number, // 业务模板角色id roleName: string, // 业务模板角色名称 managerType: number, // 业务模板角色管理身份类型, 1:管理者(主持人); 2: 辅助管理者(联席主持人); 3: 普通参会人 type: number, //0,标准,1,专业模板 } ], // 业务模板角色列表 }, msg:''}

close

方法名 调用端 类型 说明 PC(MAC) Android Ios 直播间web
close js 异步 关闭当前窗口
  • 参数
  • 返回值
{ code:200, msg:''}
方法名 调用端 类型 说明 PC(MAC) Android Ios 直播间web
openLink js 异步 通过用户默认浏览器打开一个网页
  • 参数
{ url: string} 
  • 返回值
{ code:200, msg:''} 

getInteractiveToolInfo

方法名 调用端 类型 说明 PC(MAC) Android Ios 直播间web
getInteractiveToolInfo js 异步 获取互动模板内容 × × ×
  • 参数
{ templateId: number, //互动模板id} 
  • 返回值

{ code:200, data: { templateId: number, //互动模板id, data: string, //互动模板内容数据,json转string title: string, //互动主题 typeId: number, //互动类型id } msg:''}

setInteractiveToolInfo

方法名 调用端 类型 说明 PC(MAC) Android Ios 直播间web
setInteractiveToolInfo js 异步 设置互动模板内容 × × ×
  • 参数
{ templateId: number, //互动模板id,(可选),如果不传则为新建模板 data: string, //互动模板内容数据,json转string title: string, //互动主题 typeId: number, //互动类型id} 
  • 返回值
{ code:200, msg:''} 

getInteractiveToolInfoList

方法名 调用端 类型 说明 PC(MAC) Android Ios 直播间web
getInteractiveToolInfoList js 异步 获取某个类型的互动模板列表 × × ×
  • 参数
{ typeId: number, //互动工具类型id} 
  • 返回值
{ code:200, data: [], //互动模板数组,tempData可参考getInteractiveToolInfo接口返回 msg:''} 

sendCustomMessage

方法名 调用端 类型 说明 PC(MAC) Android Ios 直播间web
sendCustomMessage js 异步 发送互动消息给参会人
  • 参数
{ uuid: string, //开发者应用方生成的针对每一次互动的id destUsers: \<userinfo \>[], //参会人数组,传空会发送所有参会人 // userInfo格式:{ tempUserId: number, accid: string, extId: string, name: string } message: string, //自定义消息体 } 
  • 返回值
{ code:200, msg:''} 

getUserList

方法名 调用端 类型 说明 PC(MAC) Android Ios 直播间web
getUserList js 异步 获取所有用户的列表 ×
  • 参数
  • 返回值
{ code:200, data:<userinfo\>[], //用户列表数组,userInfo参考getSelf接口返回 msg:''} 

getSelf

方法名 调用端 类型 说明 PC(MAC) Android Ios 直播间web
getSelf js 异步 获取当前用户
  • 参数
  • 返回值
{ code:200, data: { umsUserID: number, //ums用户id tempUserId: number, //用户会议临时id accid: string, //网易聊天室用户id extId: string, //第三方ID, 用于对接第三方的列表来源,比如直播间 name: string, //用户姓名 email: string, //用户邮箱 mobile: string, //用户手机号码,该号码是用户属性的,非电话语音使用的电话号码 interactRole : number, //用户角色 1:主持人 2: 联席主持人 3: 嘉宾 4: 观众 phoneNum: string, //电话语音使用的电话号码 status: number, //状态 0 :下线用户 1:在线用户 groupName: string, //参会人列表中用户所在的分组 imagePath: string, //头像 joinTag: string, //用户标签 confRole: { roleId: number, // 业务模板角色id roleName: string, // 业务模板角色名称 managerType: number, // 业务模板角色管理身份类型, 1:管理者(主持人); 2: 辅助管理者(联席主持人); 3: 普通参会人 type: number, //0,标准,1,专业模板 } // 新角色结构,为兼容各种类型的活动,当活动是非专业活动(不带模板),标准活动的角色( 1:主持人(管理者) 2: 联席主持人(辅助管理者) 3: 嘉宾(普通参会人) 4: 观众(普通参会人)) }, msg:''} 

inviteUserSpeak

方法名 调用端 类型 说明 PC(MAC) Android Ios 直播间web
inviteUserSpeak js 异步 邀请用户发言 × × ×
  • 参数
{ tempUserId: number, //用户会议临时id accid: string, //网易聊天室用户id extId: string, //第三方ID, 用于对接第三方的列表来源,比如直播间 name: string, //用户姓名} 
  • 返回值
{ code:200, msg:''} 

stopUserSpeak

方法名 调用端 类型 说明 PC(MAC) Android Ios 直播间web
stopUserSpeak js 异步 结束用户发言 × × ×
  • 参数

{ tempUserId: number, //用户会议临时id accid: string, //网易聊天室用户id extId: string, //第三方ID, 用于对接第三方的列表来源,比如直播间 name: string, //用户姓名 closeVideo: boolean //可选,是否同时关闭该用户视频,默认true}

  • 返回值
{ code:200, msg:''} 

getInviteSpeakUserList

方法名 调用端 类型 说明 PC(MAC) Android Ios 直播间web
getInviteSpeakUserList js 异步 获取当前发言用户列表 × × ×
  • 参数
  • 返回值
 { code:200, data: <userinfo\>[], //用户信息,参考getSelf接口 msg:''} 

isInvitedSpeakUser

方法名 调用端 类型 说明 PC(MAC) Android Ios 直播间web
isInvitedSpeakUser js 异步 判断用户是否处于被邀请发言状态 ×
  • 参数
{ tempUserId: number, //用户会议临时id accid: string, //网易聊天室用户id extId: string, //第三方ID, 用于对接第三方的列表来源,比如直播间 name: string, //用户姓名} 
  • 返回值
{ code:200, data: boolean, //用户是否处于被邀请发言状态 msg: ''} 

resizeWindow

方法名 调用端 类型 说明 PC(MAC) Android Ios 直播间web
resizeWindow js 异步 设置窗口大小 × ×
  • 参数
{ width: number, //可选 height: number, //可选 position: string //可选,窗口对齐方式,可选值:'center','bottom'} 
  • 返回值
{ code:200, msg:''} 

hideWindow

方法名 调用端 类型 说明 PC(MAC) Android Ios 直播间web
hideWindow js 异步 隐藏窗口,非关闭
  • 参数
  • 返回值
{ code:200, msg:''} 

showWindow

方法名 调用端 类型 说明 PC(MAC) Android Ios 直播间web
showWindow js 异步 窗口从隐藏状态下显示出来 ×
  • 参数
  • 返回值
{ code:200, msg:''} 

getAppLanguage

方法名 调用端 类型 说明 PC(MAC) Android Ios 直播间web
getAppLanguage js 异步 获取语言 ×
  • 参数
  • 返回值
    { code:200, data: string // 'zh', 'en' msg:''} 

getAppSkin

方法名 调用端 类型 说明 PC(MAC) Android Ios 直播间web
getAppSkin js 异步 获取主题 ×
  • 参数
  • 返回值
{ code:200, data: string // 'dark', 'light' msg:''} 

messageToast

方法名 调用端 类型 说明 PC(MAC) Android Ios 直播间web
messageToast js 异步 消息提示,常用于主动操作后的反馈提示
  • 参数
{ message: string //消息内容 type: string //可选,消息提示类型,可选值:info(默认)} 
  • 返回值
{ code:200, msg:''} 

muteAll

方法名 调用端 类型 说明 PC(MAC) Android Ios 直播间web
muteAll js 异步 全体静音 × × ×
  • 参数
  • 返回值
{ code:200, msg:''} 

unMuteAll

方法名 调用端 类型 说明 PC(MAC) Android Ios 直播间web
unMuteAll js 异步 解除全体静音 × × ×
  • 参数
  • 返回值
{ code:200, msg:''} 

log

方法名 调用端 类型 说明 PC(MAC) Android Ios 直播间web
log js 异步 输出日志到本地文件 ×
  • 参数
{ logString: string //日志内容} 
  • 返回值
{ code:200, msg:''} 

code说明

code 说明
200 操作成功
非200 操作失败,从msg看失败信息