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

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

目录
1. 桌面快捷方式接口: 1
2. 房间信息接口： 2
3. 用户登录会话验证接口: 3
4. 用户登录接口: 4
5. 录制视频接口： 5
6. 保存共享文献接口： 6
7. 房间共享文献列表接口： 7
8. 删除共享文献接口： 8
9. 保存聊天记录接口： 9
10. 修改昵称接口： 10
11. 修改密码接口： 11
12. 解散房间接口： 12
13. 聊天表情接口： 12

Revision
Author
Change log
V2.0
Yong9
2023-9-8

说明：接口地址由合作商提醒，并和我司约定接口参数，由用户操作Flash软件时触发接口请求．接口以http方式通信，并返回XML格式广本流
1. 桌面快捷方式接口
http://接口文献地址
/proxy.jsp?action=setDesktop&roomID=xxx&roomName=xxx&roomUrl=xxx
请求方式:POST
接口地址:由合作方提供
参数约定说明:
参数标记
类型
值
说明
action
字符串
setDesktop
接口执行的方法名
roomID
字符串

房间ID
roomName
字符串

房间名称
roomUrl
字符串

房间地址
http响应内容类型: text/xml
应响结果示例:
<?xml version="1.0" encoding="utf-8"?>
<root>
</root>
应响结果说明:无返回值

2. 房间信息接口:
http://接口文献地址/proxy.jsp?action=roomInfo&roomID=xxx
请求方式: POST
接口地址:由合作方提供
参数约定说明:
参数标记
类型
值
说明
action
字符串
roomInfo
接口执行的方法名
roomID
字符串

房间ID

http响应内容类型: text/xml
应响结果示例:
<?xml version="1.0" 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>Success</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(结果,值只能为Success表达成功,Error表达失败),resultInfo(结果提醒)

注意：房间表字段有[id, roomName, roomMaxUsers, autoMic, visitor,, time, note, rtmptURL, serverID(房间管理员ID)]

3. 用户登录会话验证接口:
http://接口文献地址/proxy.jsp?action=checkSession&roomID=xxx
请求方式:POST
接口地址:由合作方提供
参数约定说明:
参数标记
类型
值
说明
action
字符串
checkSession
接口执行的方法名
roomID
字符串

房间ID
http响应内容类型: text/xml
应响结果示例:
<?xml version="1.0" encoding="utf-8"?>
<root>
<user>
<id>101</id>
<account>client1</account>
<name>客户一</name>
<password>123456</password>
<userType>isUser</userType>
<sex>1</sex>
<headImg>../face/sex_1.png</headImg>
<roomAdmin>0</roomAdmin>
</user>
<result>Success</result>
<resultInfo></resultInfo>
</root>
应响结果说明:
如用户在WEB端已登录,则result节点值为Success,否则为Error,并且输出用户的个人信息,字段说明:id(用户ID),account(用户账号),name(用户昵称,在聊天室中显示),password(密码),userType(用户类别,值只能是isServer表达服务者,isUser表达会员,根据roomID找到serverID，假如serverID和用户ID相等则是isServer,否则是isUser),sex(性别,值只能是1表达男,0表达女),headImg(头像地址), roomAdmin(是否有管理权限,值只能是1表达有,0表达无),result(结果,值只能为Success表达成功,Error表达失败),resultInfo(结果提醒)

注意：假如没有会话的存在，则result值为Error，resultInfo值为notSession

4. 用户登录接口:
http://接口文献地址/proxy.jsp?action=login&roomID=xxx&account=xxx&password=xxx
请求方式: POST
接口地址:由合作方提供
参数约定说明:
参数标记
类型
值
说明
action
字符串
login
接口执行的方法名
roomID
字符串

房间ID
account
字符串

用户账号
password
字符串

用户密码

http响应内容类型: text/xml
应响结果示例:
<?xml version="1.0" encoding="utf-8"?>
<root>
<user>
<id>101</id>
<account>client1</account>
<name>客户一</name>
<password>123456</password>
<userType>isUser</userType>
<sex>1</sex>
<headImg>../face/sex_1.png</headImg>
<roomAdmin>0</roomAdmin>
</user>
<result>Success</result>
<resultInfo></resultInfo>
</root>

应响结果说明:
如用户在FLASH端登录,输出用户的个人信息
字段说明:id(用户ID),account(用户账号),name(用户昵称,在聊天室中显示),password(密码),userType(用户类别,值只能是isServer表达服务者,isUser表达会员,根据roomID找到serverID，假如serverID和用户ID相等则是isServer,否则是isUser),sex(性别,值只能是1表达男,0表达女),headImg(头像地址), roomAdmin(是否有管理权限,值只能是1表达有,0表达无),result(结果,值只能为Success表达成功,Error表达失败),resultInfo(结果提醒)

5. 录制视频接口:
http://接口文献地址/proxy.jsp?action=saveRecordVideo&roomID=xxx&userID=xxx&password =xxx&recordName=xxx&recordFileName=xxx&synch=xxx&download=xxx&recordType=xxx
请求方式: POST
接口地址:由合作方提供
参数约定说明:
参数标记
类型
值
说明
action
字符串
saveRecordVideo
接口执行的方法名
roomID
字符串

房间ID
userID
字符串

用户ID
password
字符串

密码
recordName
字符串

录制名称
recordFileName
字符串

录制文献名
synch
字符串

是否同步显示
download
字符串

是否下载
recordType
字符串

录制类型

http响应内容类型: text/xml
应响结果示例:
<?xml version="1.0" encoding="utf-8"?>
<root>
<uploadFile>
<id>100</id>
<userID>1</userID>
<fileName>Java视频教程</fileName>
<fileType>flv</fileType>
<url>:5080/fserver/uploads/63.flv</url>
<count>1</count>
<download>0</download>
</uploadFile>
<synch>true</synch>
<result>Success</result>
<resultInfo></resultInfo>
</root>
应响结果说明:
如用户在FLASH端登录,输出用户的录制结果
字段说明:id(录制文献保存在共享文献表的 ID), userID (录制者ID), fileName(录制文献名称), fileType(录制文献类型,只能是flv) , url (录制文献地址), count(数量,只能为1), download (是否允许下载,值只能是1表达允许,0表达不允许), synch(是否同步显示,值只能是true表达同步,并同时返回uploadFile结构数据,false表达不同步,不用返回uploadFile结构数据),result(结果,值只能为Success表达成功,Error表达失败),resultInfo(结果提醒)

6. 保存共享文献接口:
http://接口文献地址/proxy.jsp?action=saveUploadFile&roomID=xxx&userID=xxx&password =xxx&fileName=xxx&fileType=xxx&url=xxx&count=xxx&download=xxx
请求方式: POST
接口地址:由合作方提供
参数约定说明:
参数标记
类型
值
说明
action
字符串
saveUploadFile
接口执行的方法名
roomID
字符串

房间ID
userID
字符串

用户ID
password
字符串

密码
fileName
字符串

上传文献名称
fileType
字符串

文献后缀名
url
字符串

上传后文献地址
count
字符串

页数
download
字符串

是否允许下载

http响应内容类型: text/xml
应响结果示例:
<?xml version="1.0" encoding="utf-8"?>
<root>
<id>1</id>
<result>Success</result>
<resultInfo></resultInfo>
</root>
应响结果说明:输出保存结果
字段说明:id(上传后插入数据库的序号,唯一的),result(结果,值只能为Success表达成功,Error表达失败),resultInfo(结果提醒)

7. 房间共享文献列表接口:
http://接口文献地址/proxy.jsp?action=listUploadFile&roomID=xxx
请求方式: POST
接口地址:由合作方提供
参数约定说明:
参数标记
类型
值
说明
action
字符串
listUploadFile
接口执行的方法名
roomID
字符串

房间ID

http响应内容类型: text/xml
应响结果示例:
<?xml version="1.0" encoding="utf-8"?>
<root>
<uploadFileList>
<uploadFile>
<id>1</id>
<userID>1</userID>
<fileName>远程视频教育平台销售协议远程视频教育平台销售协议</fileName>
<fileType>doc</fileType>
<url>:5080/fserver/uploads/9.doc</url>
<count>2</count>
<download>0</download>
</uploadFile>
<uploadFileList>
</root>
应响结果说明:输出保存结果
字段说明: id(序号),userID(上传者ID),fileName(文献名) , fileType(文献后缀名) , url(文献后地址) , count(页数) , download (是否下载,值只能是1表达允许下载,0表达不允许)

8. 删除共享文献接口:
http://接口文献地址/proxy.jsp?action=deleteUploadFile&roomID=xxx&userID=xxx&password =xxx&id=xxx
请求方式: POST
接口地址:由合作方提供
参数约定说明:
参数标记
类型
值
说明
action
字符串
saveUploadFile
接口执行的方法名
roomID
字符串

房间ID
userID
字符串

用户ID
password
字符串

密码
id
字符串

文献ID

http响应内容类型: text/xml
应响结果示例:
<?xml version="1.0" encoding="utf-8"?>
<root>
<result>Success</result>
<resultInfo></resultInfo>
</root>
应响结果说明:输出保存结果
字段说明:result(结果,值只能为Success表达成功,Error表达失败),resultInfo(结果提醒)

9. 保存聊天记录接口:
http://接口文献地址/proxy.jsp?action=saveChat&roomID=xxx&sendUserID=xxx&sendUserName=xxx&acceptUserID=xxx&acceptUserName=xxx&content=xxx
请求方式: POST
接口地址:由合作方提供
参数约定说明:
参数标记
类型
值
说明
action
字符串
saveChat
接口执行的方法名
roomID
字符串

房间ID
sendUserID
字符串

发送者ID
sendUserName
字符串

发送者昵称
acceptUserID
字符串

接受者ID
acceptUserName
字符串

接受者昵称
content
字符串

内容

http响应内容类型: text/xml
应响结果示例:
<?xml version="1.0" encoding="utf-8"?>
<root>
</root>
应响结果说明:无返回值

10. 修改昵称接口:
http://接口文献地址/proxy.jsp?action=editNickname&operatorID=xxx&operatorPWD=xxx&userID=xxx&nickname=xxx
请求方式: POST
接口地址:由合作方提供
参数约定说明:
参数标记
类型
值
说明
action
字符串
editNickname
接口执行的方法名
operatorID
字符串

操作者ID
operatorPWD
字符串

操作者密码
userID
字符串

被修改用户ID
nickname
字符串

新昵称

http响应内容类型: text/xml
应响结果示例:
<?xml version="1.0" encoding="utf-8"?>
<root>
<result>Success</result>
<resultInfo></resultInfo>
</root>
应响结果说明:输出保存结果
字段说明:result(结果,值只能为Success表达成功,Error表达失败),resultInfo(结果提醒)

11. 修改密码接口:
http://接口文献地址/proxy.jsp?action=editPassword&userID=xxx&oldPWD=xxx&newPWD=xxx
请求方式: POST
接口地址:由合作方提供
参数约定说明:
参数标记
类型
值
说明
action
字符串
editPassword
接口执行的方法名
userID
字符串

用户ID
oldPWD
字符串

旧密码
newPWD
字符串

新密码

http响应内容类型: text/xml
应响结果示例:
<?xml version="1.0" encoding="utf-8"?>
<root>
<result>Success</result>
<resultInfo></resultInfo>
</root>
应响结果说明:输出保存结果
字段说明:result(结果,值只能为Success表达成功,Error表达失败),resultInfo(结果提醒)

12. 解散房间接口:
http://接口文献地址/proxy.jsp?action=dissolveRoom&roomID=xxx&account=xxx&password =xxx
请求方式: POST
接口地址:由合作方提供
参数约定说明:
参数标记
类型
值
说明
action
字符串
dissolveRoom
接口执行的方法名
roomID
字符串

房间ID
account
字符串

用户账号
password
字符串

密码

http响应内容类型: text/xml
应响结果示例:
<?xml version="1.0" encoding="utf-8"?>
<root>
<result>Success</result>
<resultInfo></resultInfo>
</root>
应响结果说明:输出保存结果
字段说明:result(结果,值只能为Success表达成功,Error表达失败),resultInfo(结果提醒)

13. 聊天表情列表接口:
http://接口文献地址/proxy.jsp?action=chatfaceList&page=xxx&pageSize=xxx
请求方式: POST
接口地址:由合作方提供
参数约定说明:
参数标记
类型
值
说明
action
字符串
chatfaceList
接口执行的方法名
page
字符串

当前页码
pageSize
字符串

每条记录数

http响应内容类型: text/xml
应响结果示例:
<?xml version="1.0" encoding="utf-8"?>
<root>
<chatfaceList>
<chatface>
<id>1</id>
<ico>/face/1.swf</ico>
<name>笑脸</name>
</chatface>
<chatface>
<id>2</id>
<ico>/face/2.swf</ico>
<name>哭脸</name>
</chatface>
<pageCount>1</pageCount>
<totalRecords>2</totalRecords>
<chatfaceList>
</root>
应响结果说明:输出保存结果
字段说明: id(序号),ico(表情文献地址),name(表情名称)
pageCount (总页数) , totalRecords (总记录数)
深圳市腾创网络技术有限公司