2.2. 外部设备导入导出 REST API

2.2.1. 版本信息

v1.02, 2017/04/10

2.2.2. 创建外部user对象并加会

请求说明: http://xx.yy.zz:8050/avd/api/outgoing/createOutgoingUser HTTP/1.1

接口描述: 创建一个外部user对象并让它加入会议

参数	类型	必须	说明
accessToken	String	是	认证成功后根据规则生成的串
roomId	String	是	房间ID
userId	String	是	用户ID，唯一
userName	String	是	用户名称
userAddress	String	是	设备地址，如rtsp://192.168.100.100:888
userData	String	否	用户数据，可为空
options	Object	否	可选项，JSON对象，传入一些需要的参数比如rtsp的话，需要传入用户名和密码，{‘login_name’:‘111’,’login_password’:’x’}

返回说明:

http 响应:json
{
    "ret": 0,
    "data": {
      roomId:'r8',
      userId:'xxxxx'
    }
}


result: 返回码，0为成功，非0为失败

roomId：传入的房间Id返回

userId：传入的用户Id返回

主要返回码: 0,423,424,425,426,427

2.2.3. 删除外部user对象并离会

请求说明: GET http://xx.yy.zz:8050/avd/api/outgoing/destroyOutgoingUser HTTP/1.1

接口描述: 删除外部对象并让它离开会议

参数	类型	必须	说明
access_token	String	是	认证成功后根据规则生成的串
roomId	String	是	房间ID
userId	String	是	用户ID，唯一D
userAddress	String	是	设备地址，如rtsp://192.168.100.100:888

返回说明:

http 响应:json
{
    "ret": 0,
    "data": {
     roomId:'r8',
     userId:'xxxxx'
    }
}

主要返回码: 0,424,425

2.2.4. 获取外部user对象

请求说明: http://xx.yy.zz:8050/avd/api/outgoing/getOutgoingUsers HTTP/1.1

接口描述: 根据房间Id返回房间中的所有外部user对象。如果传入的roomId为空，则返回所有外部user对象。

参数	类型	必须	说明
accessToken	String	是	认证成功后根据规则生成的串
roomId	String	否	房间Id，不输入则返回所有

返回说明:

http 响应:json
{
    "ret": 0,
    "data": {
                "total" : 21,
                "items":[
                "roomId" : "r8",
                      "userId" : uuid,
                      "userName" : "test",
                          "userAddress" : "rtsp://192.168.100.100:888",
                      "userData":"",
                      "options": {"key":"value"}
                ]
    }
}

主要返回码: 0

2.2.5. 错误码表

ret	详细描述
0	成功
302	创建失败，多是后台服务未启动
303	删除失败，多是后台服务未启动
304	获取失败，多是后台服务未启动
310	返回超时，多是后台服务未启动
401	参数不对
423	用户已存在
425	用户不存在
426	加会失败
427	等待应答超时