会议API

API返回值为JSON,形式为:

{code:xxx, msg:xxx}

有数据返回,形式为:

{code:xxx, msg:xxx, data:xxx}
字段 说明
code 1:成功;其它值:失败
msg 提示信息
data 依据具体API返回对应数据

申请同步

ndc_applySyncView
  • 类型:async
  • 参数:无
  • 返回值
    {code:1,msg:'成功'}

取消同步

ndc_cancelSyncView
  • 类型:async
  • 参数:无
  • 返回值
    {code:1,msg:'成功'}

修改会议标题

ndc_setMeetingTitle
  • 类型:async
  • 参数title:会议标题,string类型
  • 返回值
    {code:1,msg:'成功'}

设置主持人

ndc_setHost
  • 类型:async
  • 参数userId:成员id,number类型
  • 返回值
    {code:1,msg:'成功'}

移出成员

ndc_forceLeave
  • 类型:async
  • 参数userId:成员id,number类型
  • 返回值
    {code:1,msg:'成功'}

退出会议

ndc_quitMeeting
  • 类型:async
  • 参数:无
  • 返回值
    {code:1,msg:'成功'}

邀请成员

ndc_inviteMember
  • 类型:async:
  • 参数inviteUsers:邀请的成员的信息列表,array类型。
成员信息列表定义如下:
字段 说明
id 成员id,number类型
name 成员名称,string类型
avatar 头像URL,string类型(非必填项)

示例:

[{id:"成员id", name:"名称", avatar:"头像" }]

返回值:

{code:1,msg:'成功'}

结束会议

ndc_closeMeeting
  • 类型:async
  • 参数:无
  • 返回值
    {code:1,msg:'成功'}

打开文件

ndc_openFile
  • 类型:async
  • 参数
    • fileType:number类型,2表示2D图纸,3表示3D模型。
    • lightWeightUrl::string类型,轻量化文件地址。
    • fileName:string类型,非必填,轻量化文件名称。
  • 返回值
    {code:1,msg:'成功'}

快速截屏

ndc_quickScreenShot
  • 类型:async
  • 参数:无
  • 返回值
    {code:1,data:'base64数据',msg:'操作取消'}

删除指定批注

ndc_delTag
  • 类型:async
  • 参数id:string类型,待删除批注的id。
  • 返回值
    {code:1,msg:'成功'}

获取会议标题和邀请链接

ndc_getMeetInfo
  • 类型:async
  • 参数:无
  • 返回值
    {code:1,msg:'成功',data:{}}

返回值详情:

字段 说明
code 1:成功 ;其它值:失败
msg 提示信息
data 会议信息数组,具体字段如下
   meetingTitle 会议标题
   meetingLink 会议链接
   meetingNumber 会议ID
   startTime 会议开始时间

获取会议成员信息

ndc_getMemberInfo
  • 类型:async
  • 参数:无
  • 返回值
    {code:1,msg:'成功',data:[]}

返回值详情:

字段 说明
code 1:成功 ;其它值:失败
msg 提示信息
data 成员信息数组,具体字段如下
   userId 用户id
   userName 用户名称
   userRole 用户角色
  • 0:参与人
  • 1:主持人
   operateRole 操作角色
  • 0:观看者
  • 1:操作者
   accessType 用户是否进入过会议
  • 0:从未进入过会议
  • 1:已进入过
   type 用户类型
  • 0:平台用户
  • 1:非平台用户
   status 用户状态
  • 0:未参会
  • 1:正在会议中
  • 2:退出
   joinTime 加入会议时间
   avatar 用户头像
   id 主键id
   meetingId 会议id

获取会议打开过的文件列表

ndc_getMeetFiles
  • 类型:async
  • 参数:无
  • 返回值
    {code:1,msg:'成功',data:[{meetingId,fileName:fileUrl,fileType,openTime}]}
postMessage方式传参:
{type: ‘ndc_getMeetFiles’}
postMessage返回值:
{type: ‘ndc_getMeetFilesResponse’, msg:{code:1, msg:'成功', data: 文件列表}}

返回值详情:

字段 说明
code 1:成功

其它值:失败

msg 提示信息
data 文件信息数组,具体字段如下
   fileID 文件ID
   fileName 文件名称
   fileUrl 轻量化文件地址
   fileType 文件类型
  • 2:2D图纸
  • 3:3D模型
   openTime 打开时间

获取当前打开文件的批注信息

ndc_getCurrentTag
  • 类型:async
  • 参数:无
  • 返回值
    {code:1,msg:'成功',data:[]}

返回值详情:

字段 说明
code 1:成功;其它值:失败
msg 提示信息
data 批注信息数组,具体字段如下
   meetingId 会议ID
   fileId 文件ID
   taglist 批注数据
        content  批注详细信息
        operType   批注类型
        imageSrc 批注图片
        id   批注ID
        userId  用户ID
        userName 用户名称
        avatar  用户头像
        updateTime 更新时间

监听成员信息变化通知事件

ndc_onMemberInfoChange
  • 类型:async
  • 参数:无
  • 返回值
    {type:'MEMBER_JOIN'}

监听批注数据变化通知事件

ndc_onTagInfoChange
  • 类型:async
  • 参数:无
  • 返回值
    {type:'COMMENT_ADD'}