智能会议接入协议

协议说明

智能会议接入协议主要描述了智能翻页笔、智能白板等会议场景下会议设备与应用如何通过数据交互实现设备授权、会议开启等关键业务。

交互指令

设备授权登录

POT软件在开始会议前,需要用户通过得力E+APP扫码的方式进行登录授权操作,登录成功后平台会返回授权用户相关信息,具体返回内容见指令205

设备端显示的登录二维码格式见设备授权二维码

会议应用服务端可以通过设备端获取到的token信息在服务器端通过指令509进行再次验证,确保授权有效。

会议启动

当用户登录成功后,POT会生成会议信息,包括会议编号、密码等,POT需要同步将该信息发送给得力云平台对应的会议服务,告知会议已启动,随后平台后端会议服务开始与白板家服务器通信同步监听获取会议信息。

POT软件通过指令300向平台后端云应用发起会议通知,请求示例如下:

{
    "mid": "123456", 
    "from": "设备ID", 
    "to": "会议服务ID", 
    "time": 1502867086, 
    "action": 300,
    "data": {
        "cmd": "start_meeting", 
        "payload": {
            "user_id": "用户ID或空", 
            "meetno": "会议编号", 
            "meetname":"会议名称",
            "meetpass": "会议密码明文或空", 
            "nickname": "会议昵称或空",
            "meettype": 0
        }
    }
}
其中cmd固定为start_meeting表示会议启动,请求payload各参数说明如下:

参数 类型 描述
user_id 字符串 可选,当前POT软件登录用户ID。如果是免登模式,则为空
meetno 字符串 会议编号
meetname 字符串 可选, 会议名称
meetpass 字符串 可选,会议密码。如果无会议密码,则为空
nickname 字符串 可选,会议昵称,如果无设置,则为空
meettype 整型 可选,会议类型。0-翻页笔会议,1-白板会议,缺省是0

如果平台响应成功,平台后端会议应用会自动同步生成会议,并返回会议二维码文本。该二维码可用于微信公众号扫码加入会议,也可以用于得力智慧办公APP扫码加入会议。

平台云端应用通过指令301向POT软件返回响应数据,响应示例如下:

{
    "mid": "123456", 
    "from": "应用服务ID", 
    "to": "设备ID", 
    "time": 1502867086, 
    "action": 301, 
    "data": {
        "cmd": "start_meeting", 
        "payload": {
            "qrcode": "http://weixin.qq.com/q/02lIgFJxgoft31ssef1o1S"
        }
    }
}
响应payload各参数说明如下:

参数 类型 描述
qrcode 字符串 得力会议微信公众号/小程序生成的临时二维码URL

POT软件得到二维码信息后,需要自行根据该文本链接生成二维码图像。

注意: 如果POT软件请求得力云平台监听会议失败,开始会议按钮应不可用,同时POT软件应定时重复发送请求,直到成功为止。请求的时间间隔不低于1秒。