天天看點

xx. 會議管理1.概述2. 接口參數3.接口定義

1.概述

1.1.用途

主要用途是對會議建立和參與進行認證。

1.2.适用版本

1.3.通信協定

本規範中,業務系統是通信的伺服器端(簡稱“伺服器”),信令伺服器是通信用戶端(簡稱“用戶端”)。

用戶端和伺服器通過HTTP協定通信,用戶端使用HTTP Get 或 HTTP Post 伺服器發送請求,伺服器傳回json格式的業務資料或操作結果給用戶端。

1.4.接口請求

HTTP Get 或 POST

1.5.接口響應

伺服器傳回json格式的文本内容給用戶端。

傳回給用戶端的json文本描述了伺服器對請求的處理結果和響應資料。

1.6.接口安全

業務伺服器隻接受從信令伺服器上發來的請求。

1.7.URL編碼

當URL請求參數值中包含URL位址保留字元時,應對參數值進行URL編碼。

具體參見“RFC2396: Uniform Resource Identifiers (URI): Generic Syntax”。

當請求參數包含中文字元時,應對中文字元采用UTF-8編碼。

1.8.傳回消息結構

傳回的json消息資料結構具有嚴格的一緻性,用戶端可以采用一緻的接收和解析方式處理傳回消息。

簡單消息

簡單的傳回消息包含對請求的處理結果,結構如下:

{
    "code":0,
    "err_desc":""
}           

其中:

code 為0表示處理成功,其它值表示處理失敗。

err_desc是對錯誤的描述,在code為0時err_desc會被省略。

2. 接口參數

【必選參數】

room 房間編号,字元串 8 ~ 16個字元。

peer 參會使用者的唯一編号,1~32個字元。

信令伺服器應當将具有同等意義的房間編号和使用者編号映射成這兩個參數傳遞給接口。

【可選參數】

acct 使用者帳号,業務系統提供。

pwd 使用者密碼,業務系統提供。

name 使用者的表現名稱,來源根據需要設定,匿名登入是可能需要給一個可讀的名字。

這個三個參數由業務系統送出給信令伺服器,信令伺服器轉發給接口。

3.接口定義

3.1.開啟會議/建立會議(可選接口)

請求

/meeting/open/?room=aaabbb&peer=peerIdOrName&acct=xxx&pwd=xxx&name=xxx           

響應

```
    {
        "code":0,
        "err_desc":""
    }
    ```           

3.2.關閉會議(可選接口)

/meeting/close/?room=aaabbb&peer=peerIdOrName           

```
    {
        "code":0,
        "err_desc":""
    }
    ```           

3.3.加入會議(必要接口)

/meeting/jion/?room=aaabbb&peer=peerIdOrName&acct=xxx&pwd=xxx&name=xxx           

```
    {
        "code":0,
        "err_desc":""
    }
    ```           

3.3.離開會議(必要接口)

/meeting/leave/?room=aaabbb&peer=peerIdOrName           

```
    {
        "code":0,
        "err_desc":""
    }
    ```           

繼續閱讀