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 等待應答超時