TCM2M多人视频组件通信接口协议.doc

TCM2M多人视频组件通信接口协议目录1. 桌面快捷方式接口: 12. 房间信息接口: 23. 用户登录会话验证接口: 34. 用户登录接口: 45. 录制视频接口: 56. 保存共享文件接口: 67. 房间共享文件列表接口: 78. 删除共享文件接口: 89. 保存聊天记录接口: 910. 修改昵称接口: 1011. 修改密码接口: 1112. 解散房间接口: 1213. 聊天表情接口: -9-8说明:接口地址由合作商提示,并和我司约定接口参数,,并返回XML格式广本流桌面快捷方式接口http://接口文件地址/?action=setDesktop&roomID=xxx&roomName=xxx&roomUrl=xxx请求方式:POST接口地址:由合作方提供参数约定说明:参数标识类型值说明action字符串setDesktop接口执行的方法名roomID字符串房间IDroomName字符串房间名称roomUrl字符串房间地址http响应内容类型:text/xml应响结果示例:<?xmlversion=""encoding="utf-8"?><root></root>应响结果说明:无返回值房间信息接口:http://接口文件地址/?action=roomInfo&roomID=xxx请求方式:POST接口地址:由合作方提供参数约定说明:参数标识类型值说明action字符串roomInfo接口执行的方法名roomID字符串房间IDhttp响应内容类型:text/xml应响结果示例:<?xmlversion=""encoding="utf-8"?><root><room><id>1</id><roomName>课堂</roomName><roomMaxUsers>10</roomMaxUsers><roomMaxVideos>25</roomMaxVideos><discussFlag>1</discussFlag><roomMode>1</roomMode><autoMic>0</autoMic><visitor>0</visitor><time></time><note>好好学****天天向上</note><rtmptURL></rtmptURL></room><result>ess</result><resultInfo></resultInfo></root>应响结果说明:输出请求房间结果字段说明:id(房间ID),roomName(房间名称),roomMaxUsers(最大用户数),roomMaxVideos(讨论模式时,视频最多个数,不超过25个),discussFlag(是否允许讨论模式,值只能是1表示允许,0表示不允许),roomMode(0表示培训模式,1表示讨论模式),autoMic(是否设置为自动上麦,值只能是1表示允许自动上麦,0表示不允许),visitor(是否游客进入,值只能是1表示允许游客,0表示不允许),time(上课时间),note(课堂公告),rtmptURL(流媒体地址<red5连接地址>,默认为空,如果有多台服务器才考虑),result(结果,ess表示成功,Error表示失败),resultInfo(结果提示)注意:房间表字段有[id,roomName,roomMaxUsers,autoMic,visitor,,time,note,rtmptURL,serverID(房间管理员ID)]用户登录会话验证接口:http://接口文件地址/?action=checkSession&roomID=xxx请求方式:POST接口地址:由合作方提供参数约定说明:参数标识类型值说明action字符串checkSession接口执行的方法名roomID字符串房间IDhttp响应内容类型:text/xml应响结果示例:<?xmlversion=""encoding="utf-8"?><root><user><id>101</id><account>client1</account><name>客户一</name><password>123456</password><userType>isUser</userType><sex>1</sex><headImg>../face/</headImg><roomAdmin>0</roomAdmin></user><result>ess</result><resultInfo></resultInfo></root>应响结果说明:如用户在WEB端已