没有合适的资源?快使用搜索试试~ 我知道了~
使用POLYCOM RCM产品并且有意对RCM进行二次开发的用户、研发人员、测试人员。 本文认为读者已经拥有下列知识背景: 基本的编程经验 HTTP一般性知识 使用过RCM进行会议预约、会议控制等
资源推荐
资源详情
资源评论
API 参考手册
RCM2000
云视频管控系统
Software 2.6.0 | July 2014 | 3725-69955-001
RCM2000 API 参考手册 Version_2.6
2
目录
1. 简介 .................................................................................................................................................................... 3
1.1. 本文涉及范围 .............................................................................................................................................. 3
1.2. 本文适用读者 .............................................................................................................................................. 3
2. 参考文档 ............................................................................................................................................................ 3
3. 概述 .................................................................................................................................................................... 3
3.1. 接口规范 ...................................................................................................................................................... 4
3.2. 接口版本 ...................................................................................................................................................... 4
3.3. 接口列表 ...................................................................................................................................................... 5
4. 详细描述和示例................................................................................................................................................. 6
4.1. 登陆 .............................................................................................................................................................. 6
4.2. 获取单位列表 .............................................................................................................................................. 8
4.3. 获取终端列表 .............................................................................................................................................. 9
4.4. 获取多个终端当前状态 ............................................................................................................................ 11
4.5. 修改终端系统名称 .................................................................................................................................... 13
4.6. 获取会议列表 ............................................................................................................................................ 15
4.7. 获取历史会议列表 .................................................................................................................................... 17
4.8. 预约会议与立即会议 ................................................................................................................................ 19
4.9. 查看会议 .................................................................................................................................................... 22
4.10. 更新会议 .................................................................................................................................................. 24
4.11. 删除会议 .................................................................................................................................................. 27
4.12. 控制进行中的会议 .................................................................................................................................. 29
4.13. 获取进行中会议的参会终端列表 .......................................................................................................... 31
4.14. 添加与会终端到进行中的会议 .............................................................................................................. 34
4.15. 操控参会终端 .......................................................................................................................................... 36
RCM2000 API 参考手册 Version_2.6
3
1. 简介
1.1. 本文涉及范围
本文档描述 POLYCOM RCM(Real Time Conference Management)会议管理系统的开放接口:
用户登陆以及会议相关的接口描述
接口使用示例
1.2. 本文适用读者
使用 POLYCOM RCM 产品并且有意对 RCM 进行二次开发的用户、研发人员、测试人员。
本文认为读者已经拥有下列知识背景:
基本的编程经验
HTTP 一般性知识
使用过 RCM 进行会议预约、会议控制等
2. 参考文档
RCM 2000 User Guide.docx
HTTP 协议简介 - http://baike.baidu.com/view/1628025.htm?fromId=70545
REST 规范简介 - http://baike.baidu.com/view/1077487.htm
3. 概述
RCM 会议管理服务的开放接口为“REST 风格”的 WEB API。通过本接口,可以完成登陆、预约
RCM2000 API 参考手册 Version_2.6
4
会议、获取会议列表、控制会议等功能。目前不提供开发 SDK,客户端可以用任意语言比如 Java、
C/C++、Python 来直接访问 RCM Web API。
关于“REST 风格”,请参考文档“REST 规范简介”。
3.1. 接口规范
接口的一般格式为:
[protocol]://host/api/rest/<version>/<resource>?token=<token>
其中:
[protocol]: http 或 https;
<version>: 接口版本,可以为 v1.0、 v1.1、v2.0等;
<resource>: 服务资源定位符,比如 login、meetings、meetings/123;
<token>: 验证用户已经登陆的令牌.
下表所列约定适用于本文所有接口。
规 范
备注和例子
URL 路径前缀
/api/rest
所有接口以此前缀开头,例如登陆接口 URL:
http://10.250.52.130/api/rest/v1.0/login
接口版本化
URL=“…/<version>/…”
URL 的添加、减少,消息格式的变化,接口参数的改变等
都会导致生成新版本的接口,例如:/api/rest/v1.0/login,
服务器会保持一定的前向兼容性,比如同时支持 n/n-1/n-2
版本
HTTP 数据格式
JSON
目前只支持 JSON 作为 HTTP 消息体格式
非登录接口认证
token
登陆成功后,服务器在应答消息里面含有 token(字符
串),之后的预约会议等所有操作均需将这个 token 作为
URL 参数带给服务器。
客户端停止用 token 访问服务器满24小时,则此 token 自动
失效,需要重新登陆,以获取新的 token。
错误处理
提示码
应答消息体里面的 JSON 带提示码,例如:
{"errorCode":2003,"errorInfo":"用户名或密码错误!"}。提示
码和提示消息文本见每个接口的详细描述。
表1 一般性约定
3.2. 接口版本
本文所述接口的版本均为 v1.0 。
若用其他版本号访问本接口,服务器会给出错误提示。
一个客户端的所有请求需从属于同一个版本。
RCM2000 API 参考手册 Version_2.6
5
3.3. 接口列表
序号
名称
URL 路径
1
登陆
/api/rest/v1.0/login
2
获取单位列表
/api/rest/v1.0/units
3
获取终端列表
/api/rest/v1.0/endpoints
4
获取多个终端当前状
态
/api/rest/v1.0/endpointsStatus/<endpointIds>
5
修改终端系统名称
/api/rest/v1.0/endpoints/<endpointId>
6
获取会议列表
/api/rest/v1.0/meetings
7
获取历史会议列表
/api/rest/v1.0/historyMeetings
8
预约会议与立即会议
/api/rest/v1.0/meetings
9
查看会议
/api/rest/v1.0/meetings/<meetingId>
10
更新会议
/api/rest/v1.0/meetings/<meetingId>
11
删除会议
/api/rest/v1.0/meetings/<meetingId>
12
操控进行中的会议
/api/rest/<version>/meetings/<meetingId>/control/<controlType>
13
获取进行中会议的参
会终端列表
/api/rest/v1.0/meetings/<meetingId>/participants
14
添加与会终端到进行
中的会议
/api/rest/v1.0/meetings/<meetingId>/participants
15
操控参会终端
/api/rest/v1.0/meetings/<meetingId>/participants/<participantId>/control/<controlType>
表2 接口列表
剩余36页未读,继续阅读
资源评论
dujie2018
- 粉丝: 0
- 资源: 1
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
最新资源
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功