1.概述

1.1.用途

主要用途是对会议进行管理

1.2.适用版本

略

1.3.通信协议

本规范中，业务系统是通信的服务器端（简称“服务器”），信令服务器是通信客户端（简称“客户端”）。
客户端和服务器通过HTTP协议通信，客户端使用HTTP Get 或 HTTP Post向服务器发送请求，服务器返回json格式的业务数据或操作结果给客户端。用GET还是POST方式发送请求，要根据具体情况，例如简单的情况可以GET，大量数据的提交可以POST。

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.描述约定

1.9.返回消息结构

返回的json消息数据结构具有严格的一致性，客户端可以采用一致的接收和解析方式处理返回消息。
简单消息
简单的返回消息包含对请求的处理结果，结构如下：

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

其中：
code 为0表示处理成功，其它值表示处理失败。
err_desc是对错误的描述，在code为0时err_desc会被省略。
特殊情况，在用户认证的login1和login2接口中，err_desc具有特殊用途用法，具体参见接口描述。除这两个接口之外，err_desc都表示错误描述。
带业务数据的消息
有的返回消息除了包含处理结果信息，还包含业务数据记录集，结构如下：

{
        "code":0,
        "data":{
            "count":1,
            "items":[{
            "server":"g3",
            }]
        }            
    }

其中：
data 业务数据的根节点：
count 业务数据的条数，可能的值为0 ~ n
items 业务数据，是一个数组，数据条数由count属性定义。当count为0时，items属性可能为null或者不存在。
本文档后续章节中，在描述items元素的属性时，会省略一些属性的描述，即实际调用接口返回的属性在本文档中可能会没有描述，这种情况下请直接忽略被忽略描述的属性值。本文档中描述的属性是实际返回内容的一个子集，没有描述到的内容对集成本系统没有影响。
带分页数据的消息
如果返回数据较多，服务器会对返回的数据进行分页，客户端可以按照页码请求指定范围的数据。带分页信息的返回数据结构如下：

{
"code":0,
"data":{
    "page":1,
    "page_size":"20",
    "pages":"1",
    "total":"2",
    "count":2,
    "items":[...]
            }

}
分页数据信息在data元素下，意义如下：
page 当前页码
page_size 每页数据记录条数
pages 总共的页数
total 总数据条数
count 当前返回页的数据条数
如果返回的数据带有分页信息，则可以在调用接口时使用page参数来请求指定页码的数据。

2.0 接口参数

本规范中的接口参数以接口描述内为主。

2 接口定义

2.1 创建房间/修改房间

请求

/meetingmanage/room/?id=1&server_id=1&room=1122&name=会议&max_users=4&start_time=2018-11-13 10:23:00&end_time=2018-11-13 11:23:00&open_class=2

参数：
id:1(可选提供ID则为修改信息，缺失则创建)
server_id：信令服务器ID
room：房间编号 (对应视频会议系统中的房间号)
name：房间名称
max_users：最大参会人数（允许的最大参会人数.0 表示不限制）
start_time 开始时间
end_time 结束时间
open_class 开放级别(0 = 安全会议要求参会人必须在参会人列表中1 = 机构会议要求参会人必须在用户列表中。2 = 开放会议，参会人可以不用户列表中，也无需做身份认证。默认 1)

响应

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

返回0代表创建成功，其他值错误信息将在err_desc内描述。

2.2 查询房间列表

请求

/meetingmanage/getRoom/?id=1

参数
id:需要查询单个房间信息，缺失则查询出所有房间（可选）
page:第几页，默认为1
page_size:每页数量，默认50
响应

 {
    "code":0,
    "data":{
        "page":1,
        "page_size":"20",
        "pages":"1",
        "total":"2",
        "count":2,
        "items":[{
                        "id":"1",
                        "server_id":"1",
                        "room":"34ewer24",
                        "name":"会议名字",
                        "max_users":"5",
                        "users_num":"4",
                        "add_time":"2018-11-13 11:10:00",
                        "update_time":"2018-11-13 11:10:00",
                        "start_time":"2018-11-13 11:10:00",
                        "end_time":"2018-11-13 11:10:00",
                        "open_class":"2",
                        "status":"1"
            }]
       }
}

2.3修改状态/删除房间

请求

/meetingmang/roomStatus/?id=1&status=2

参数：
id：需要修改的房间ID
status:0 = 关闭1 = 开启 2 禁用 -1 删除
响应

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

2.4创建用户/修改用户

请求

/meetingmanage/user?id=1&name=user1&acct=123456&pwd=123456&status=1&is_master=1

参数：
id:1(可选提供ID则为修改信息，缺失则创建)
name：用户姓名
acct：帐号
pwd：密码
status：状态（0 注册 1 正常 2 禁用 -1 删除）
is_master ：是否主持人（1 为主持人）

响应

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

返回0代表创建成功，其他值错误信息将在err_desc内描述。

2.5查询用户

请求

/meetingmanage/getUser/?id=1

参数（可选）
id:需要查询单个用户信息，缺失则查询出所有用户
响应

 {
    "code":0,
    "data":{
        "page":1,
        "page_size":"20",
        "pages":"1",
        "total":"2",
        "count":2,
        "items":[{
                        "id":"1",
                        "name":"user1",
                        "acct":"123456",
                        "name":"会议名字",
                        "status":"1",
                        "add_time":"2018-11-13 11:10:00",
                        "update_time":"2018-11-13 11:10:00",
                        "is_master":"1"
            }]
       }
}

2.6修改状态/删除房间

请求

/meetingmang/userStatus/?id=1&status=2