天天看点

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":""
    }
    ```           

继续阅读