房间管理
创建房间
API接口URL
http://www.cloudroom.com/CLOUDROOM-API/room/create
参数
公共参数
返回数据
| 名称 | 类型 | 说明 |
| RspCode | String | 响应码 |
| RspDesc | string | 响应描述 |
| Data | map | 数据集合 |
Data数据
返回状态码RspCode说明
| 数值 | 说明 |
| 0 | 请求成功 |
| 1 | 鉴权失败(企业未开通接口权限) |
| 2 | 账号不存在 |
| 3 | 密码错误 |
| 4 | 未获取到正确参数 |
| 5 | 未知错误 |
删除房间
API接口URL
http://www.cloudroom.com/CLOUDROOM-API/room/delete
参数
公共参数
接口参数
| 名称 | 类型 | 是否必传 | 说明 |
| RoomId | Integer | 是 | 房间号 |
返回数据
| 名称 | 类型 | 说明 |
| RspCode | String | 响应码 |
| RspDesc | string | 响应描述 |
返回状态码RspCode说明
| 数值 | 说明 |
| 0 | 请求成功 |
| 1 | 用户所属企业没有接口API权限 |
| 2 | 账号不存在 |
| 3 | 密码错误 |
| 4 | 未获取到正确参数 |
| 5 | 未知错误 |
| 6 | 缺少必传参数 |
查询房间在线人数
API接口URL
http://www.cloudroom.com/CLOUDROOM-API/room/onlineUsersNum/query
参数
公共参数
接口参数
| 名称 | 类型 | 是否必传 | 说明 |
| RoomIds | String | 是 | 房间号,可以传多个(不超过50个),以英文符号,隔开,例如:12345678,23456789,34567890 |
返回数据
| 名称 | 类型 | 说明 |
| RspCode | String | 响应码 |
| RspDesc | string | 响应描述 |
| Data | map | 数据集合 |
Data数据
| 名称 | 类型 | 说明 |
| RoomId | long | 房间号 |
| UsersCount | long | 人数 |
返回状态码RspCode说明
| 数值 | 说明 |
| 0 | 请求成功 |
| 1 | 用户所属企业没有接口API权限 |
| 2 | 账号不存在 |
| 3 | 密码错误 |
| 4 | 未获取到正确参数 |
| 5 | 未知错误 |
| 6 | 缺少必传参数 |
查询房间在线成员信息
API接口URL
http://www.cloudroom.com/CLOUDROOM-API/room/onlineMembers/query
参数
公共参数
接口参数
| 名称 | 类型 | 是否必传 | 说明 |
| RoomId | Integer | 是 | 房间号 |
返回数据
| 名称 | 类型 | 说明 |
| RspCode | String | 响应码 |
| RspDesc | string | 响应描述 |
| Data | map | 数据集合 |
Data数据
| 名称 | 类型 | 说明 |
| NickName | String | 成员昵称 |
| JoinTime | Long | 进入时间,Unix时间戳 |
返回状态码RspCode说明
| 数值 | 说明 |
| 0 | 请求成功 |
| 1 | 用户所属企业没有接口API权限 |
| 2 | 账号不存在 |
| 3 | 密码错误 |
| 4 | 未获取到正确参数 |
| 5 | 未知错误 |
| 6 | 缺少必传参数 |
查询用量(按天统计)
API接口URL
http://www.cloudroom.com/CLOUDROOM-API/room/usageInfo/all/query
参数
公共参数
接口参数
| 名称 | 类型 | 是否必传 | 说明 |
| FromDate | String | 否 | 起始时间,例如2017-01-01,格式:YYYY-MM-DD |
| ToDate | String | 否 | 截止时间,例如2017-01-10,格式:YYYY-MM-DD |
返回数据
| 名称 | 类型 | 说明 |
| RspCode | String | 响应码 |
| RspDesc | string | 响应描述 |
| Data | map | 数据集合 |
Data数据
| 名称 | 类型 | 说明 |
| Date | String | 日期 |
| Audio | Long | 音频时长(单位:分钟) |
| WB | Long | 白板时长(单位:分钟) |
| RecordCA | Long | 录制1~5方时长(单位:分钟) |
| RecordCB | Long | 录制6~9方时长(单位:分钟) |
| SD | Long | 视频标清时长(单位:分钟) |
| HD | Long | 视频高清时长(单位:分钟) |
| HDP | Long | 视频超清时长(单位:分钟) |
返回状态码RspCode说明
| 数值 | 说明 |
| 0 | 请求成功 |
| 1 | 用户所属企业没有接口API权限 |
| 2 | 账号不存在 |
| 3 | 密码错误 |
| 4 | 未获取到正确参数 |
| 5 | 未知错误 |
| 6 | 缺少必传参数 |
查询用量(按天和房间统计)
API接口URL
http://www.cloudroom.com/CLOUDROOM-API/room/usageInfo/query
参数
公共参数
接口参数
| 名称 | 类型 | 是否必传 | 说明 |
| RoomIds | String | 否 | 房间号,可以传多个(不超过50个),以英文符号,隔开,例如:12345678,23456789,34567890 |
| FromDate | String | 否 | 起始时间,例如2017-01-01,格式:YYYY-MM-DD |
| ToDate | String | 否 | 截止时间,例如2017-01-10,格式:YYYY-MM-DD |
返回数据
| 名称 | 类型 | 说明 |
| RspCode | String | 响应码 |
| RspDesc | string | 响应描述 |
| Data | map | 数据集合 |
Data数据
| 名称 | 类型 | 说明 |
| RoomId | Long | 房间id |
| Usages | List | 用量情况 |
Usages数据
| 名称 | 类型 | 说明 |
| Date | String | 日期 |
| Audio | Long | 音频时长(单位:分钟) |
| WB | Long | 白板时长(单位:分钟) |
| RecordCA | Long | 录制1~5方时长(单位:分钟) |
| RecordCB | Long | 录制6~9方时长(单位:分钟) |
| SD | Long | 视频标清时长(单位:分钟) |
| HD | Long | 视频高清时长(单位:分钟) |
| HDP | Long | 视频超清时长(单位:分钟) |
返回状态码RspCode说明
| 数值 | 说明 |
| 0 | 请求成功 |
| 1 | 用户所属企业没有接口API权限 |
| 2 | 账号不存在 |
| 3 | 密码错误 |
| 4 | 未获取到正确参数 |
| 5 | 未知错误 |
| 6 | 缺少必传参数 |