多人視頻組件通信接口協(xié)議

TCM2M多人視頻組件通信接口協(xié)議

目錄HYPERLINKHYPERLINK

HYPERLINKHYPERLINKHYPERLINKRevisionAuthorChangelogV2.0Yong92023-

說明：接口地址由合作商提醒，并和我司約定接口參數(shù)，由用戶操作Flash軟件時觸發(fā)接口請求．接口以http方式通信，并返回XML格式廣本流桌面快捷方式接口http://接口文獻地址

/proxy.jsp?action=setDesktop&roomID=xxx&roomName=xxx&roomUrl=xxx請求方式:POST接口地址:由合作方提供參數(shù)約定說明:參數(shù)標(biāo)記類型值說明action字符串setDesktop接口執(zhí)行的方法名roomID字符串房間IDroomName字符串房間名稱roomUrl字符串房間地址http響應(yīng)內(nèi)容類型:text/xml應(yīng)響結(jié)果示例:<?xmlversion="1.0"encoding="utf-8"?><root></root>應(yīng)響結(jié)果說明:無返回值房間信息接口:http://接口文獻地址/proxy.jsp?action=roomInfo&roomID=xxx請求方式:POST接口地址:由合作方提供參數(shù)約定說明:參數(shù)標(biāo)記類型值說明action字符串roomInfo接口執(zhí)行的方法名roomID字符串房間IDhttp響應(yīng)內(nèi)容類型:text/xml應(yīng)響結(jié)果示例:<?xmlversion="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>好好學(xué)習(xí),天天向上</note><rtmptURL></rtmptURL></room><result>Success</result><resultInfo></resultInfo></root>應(yīng)響結(jié)果說明:輸出請求房間結(jié)果字段說明:id(房間ID),roomName(房間名稱),roomMaxUsers(最大用戶數(shù)),roomMaxVideos(討論模式時,視頻最多個數(shù),不超過25個),discussFlag(是否允許討論模式,值只能是1表達允許,0表達不允許),roomMode(0表達培訓(xùn)模式，1表達討論模式),autoMic(是否設(shè)立為自動上麥,值只能是1表達允許自動上麥,0表達不允許),visitor(是否游客進入,值只能是1表達允許游客,0表達不允許),time(上課時間),note(課堂公告),rtmptURL(流媒體地址<red5連接地址>,默認(rèn)為空,假如有多臺服務(wù)器才考慮),result(結(jié)果,值只能為Success表達成功,Error表達失敗),resultInfo(結(jié)果提醒)注意：房間表字段有[id,roomName,roomMaxUsers,autoMic,visitor,,time,note,rtmptURL,serverID(房間管理員ID)]用戶登錄會話驗證接口:http://接口文獻地址/proxy.jsp?action=checkSession&roomID=xxx請求方式:POST接口地址:由合作方提供參數(shù)約定說明:參數(shù)標(biāo)記類型值說明action字符串checkSession接口執(zhí)行的方法名roomID字符串房間IDhttp響應(yīng)內(nèi)容類型:text/xml應(yīng)響結(jié)果示例:<?xmlversion="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>應(yīng)響結(jié)果說明:如用戶在WEB端已登錄,則result節(jié)點值為Success,否則為Error,并且輸出用戶的個人信息,字段說明:id(用戶ID),account(用戶賬號),name(用戶昵稱,在聊天室中顯示),password(密碼),userType(用戶類別,值只能是isServer表達服務(wù)者,isUser表達會員,根據(jù)roomID找到serverID，假如serverID和用戶ID相等則是isServer,否則是isUser),sex(性別,值只能是1表達男,0表達女),headImg(頭像地址),roomAdmin(是否有管理權(quán)限,值只能是1表達有,0表達無),result(結(jié)果,值只能為Success表達成功,Error表達失敗),resultInfo(結(jié)果提醒)注意：假如沒有會話的存在，則result值為Error，resultInfo值為notSession用戶登錄接口:http://接口文獻地址/proxy.jsp?action=login&roomID=xxx&account=xxx&password=xxx請求方式:POST接口地址:由合作方提供參數(shù)約定說明:參數(shù)標(biāo)記類型值說明action字符串login接口執(zhí)行的方法名roomID字符串房間IDaccount字符串用戶賬號password字符串用戶密碼http響應(yīng)內(nèi)容類型:text/xml應(yīng)響結(jié)果示例:<?xmlversion="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>應(yīng)響結(jié)果說明:如用戶在FLASH端登錄,輸出用戶的個人信息字段說明:id(用戶ID),account(用戶賬號),name(用戶昵稱,在聊天室中顯示),password(密碼),userType(用戶類別,值只能是isServer表達服務(wù)者,isUser表達會員,根據(jù)roomID找到serverID，假如serverID和用戶ID相等則是isServer,否則是isUser),sex(性別,值只能是1表達男,0表達女),headImg(頭像地址),roomAdmin(是否有管理權(quán)限,值只能是1表達有,0表達無),result(結(jié)果,值只能為Success表達成功,Error表達失敗),resultInfo(結(jié)果提醒)錄制視頻接口:http://接口文獻地址/proxy.jsp?action=saveRecordVideo&roomID=xxx&userID=xxx&password=xxx&recordName=xxx&recordFileName=xxx&synch=xxx&download=xxx&recordType=xxx請求方式:POST接口地址:由合作方提供參數(shù)約定說明:參數(shù)標(biāo)記類型值說明action字符串saveRecordVideo接口執(zhí)行的方法名roomID字符串房間IDuserID字符串用戶IDpassword字符串密碼recordName字符串錄制名稱recordFileName字符串錄制文獻名synch字符串是否同步顯示download字符串是否下載recordType字符串錄制類型http響應(yīng)內(nèi)容類型:text/xml應(yīng)響結(jié)果示例:<?xmlversion="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>應(yīng)響結(jié)果說明:如用戶在FLASH端登錄,輸出用戶的錄制結(jié)果字段說明:id(錄制文獻保存在共享文獻表的ID),userID(錄制者ID),fileName(錄制文獻名稱),fileType(錄制文獻類型,只能是flv),url(錄制文獻地址),count(數(shù)量,只能為1),download(是否允許下載,值只能是1表達允許,0表達不允許),synch(是否同步顯示,值只能是true表達同步,并同時返回uploadFile結(jié)構(gòu)數(shù)據(jù),false表達不同步,不用返回uploadFile結(jié)構(gòu)數(shù)據(jù)),result(結(jié)果,值只能為Success表達成功,Error表達失敗),resultInfo(結(jié)果提醒)保存共享文獻接口:http://接口文獻地址/proxy.jsp?action=saveUploadFile&roomID=xxx&userID=xxx&password=xxx&fileName=xxx&fileType=xxx&url=xxx&count=xxx&download=xxx請求方式:POST接口地址:由合作方提供參數(shù)約定說明:參數(shù)標(biāo)記類型值說明action字符串saveUploadFile接口執(zhí)行的方法名roomID字符串房間IDuserID字符串用戶IDpassword字符串密碼fileName字符串上傳文獻名稱fileType字符串文獻后綴名url字符串上傳后文獻地址count字符串頁數(shù)download字符串是否允許下載http響應(yīng)內(nèi)容類型:text/xml應(yīng)響結(jié)果示例:<?xmlversion="1.0"encoding="utf-8"?><root><id>1</id><result>Success</result><resultInfo></resultInfo></root>應(yīng)響結(jié)果說明:輸出保存結(jié)果字段說明:id(上傳后插入數(shù)據(jù)庫的序號,唯一的),result(結(jié)果,值只能為Success表達成功,Error表達失敗),resultInfo(結(jié)果提醒)房間共享文獻列表接口:http://接口文獻地址/proxy.jsp?action=listUploadFile&roomID=xxx請求方式:POST接口地址:由合作方提供參數(shù)約定說明:參數(shù)標(biāo)記類型值說明action字符串listUploadFile接口執(zhí)行的方法名roomID字符串房間IDhttp響應(yīng)內(nèi)容類型:text/xml應(yīng)響結(jié)果示例:<?xmlversion="1.0"encoding="utf-8"?><root><uploadFileList><uploadFile><id>1</id><userID>1</userID><fileName>遠(yuǎn)程視頻教育平臺銷售協(xié)議遠(yuǎn)程視頻教育平臺銷售協(xié)議</fileName><fileType>doc</fileType><url>:5080/fserver/uploads/9.doc</url><count>2</count><download>0</download></uploadFile><uploadFileList></root>應(yīng)響結(jié)果說明:輸出保存結(jié)果字段說明:id(序號),userID(上傳者ID),fileName(文獻名),fileType(文獻后綴名),url(文獻后地址),count(頁數(shù)),download(是否下載,值只能是1表達允許下載,0表達不允許)刪除共享文獻接口:http://接口文獻地址/proxy.jsp?action=deleteUploadFile&roomID=xxx&userID=xxx&password=xxx&id=xxx請求方式:POST接口地址:由合作方提供參數(shù)約定說明:參數(shù)標(biāo)記類型值說明action字符串saveUploadFile接口執(zhí)行的方法名roomID字符串房間IDuserID字符串用戶IDpassword字符串密碼id字符串文獻IDhttp響應(yīng)內(nèi)容類型:text/xml應(yīng)響結(jié)果示例:<?xmlversion="1.0"encoding="utf-8"?><root><result>Success</result><resultInfo></resultInfo></root>應(yīng)響結(jié)果說明:輸出保存結(jié)果字段說明:result(結(jié)果,值只能為Success表達成功,Error表達失敗),resultInfo(結(jié)果提醒)保存聊天記錄接口:http://接口文獻地址/proxy.jsp?action=saveChat&roomID=xxx&sendUserID=xxx&sendUserName=xxx&acceptUserID=xxx&acceptUserName=xxx&content=xxx請求方式:POST接口地址:由合作方提供參數(shù)約定說明:參數(shù)標(biāo)記類型值說明action字符串saveChat接口執(zhí)行的方法名roomID字符串房間IDsendUserID字符串發(fā)送者IDsendUserName字符串發(fā)送者昵稱acceptUserID字符串接受者IDacceptUserName字符串接受者昵稱content字符串內(nèi)容http響應(yīng)內(nèi)容類型:text/xml應(yīng)響結(jié)果示例:<?xmlversion="1.0"encoding="utf-8"?><root></root>應(yīng)響結(jié)果說明:無返回值修改昵稱接口:http://接口文獻地址/proxy.jsp?action=editNickname&operatorID=xxx&operatorPWD=xxx&userID=xxx&nickname=xxx請求方式:POST接口地址:由合作方提供參數(shù)約定說明:參數(shù)標(biāo)記類型值說明action字符串editNickname接口執(zhí)行的方法名operatorID字符串操作者IDoperatorPWD字符串操作者密碼userID字符串被修改用戶IDnickname字符串新昵稱http響應(yīng)內(nèi)容類型:text/xml應(yīng)響結(jié)果示例:<?xmlversion="1.0"encoding="utf-8"?><root><result>Success</result><resultInfo></resultInfo></root>應(yīng)響結(jié)果說明:輸出保存結(jié)果字段說明:result(結(jié)果,值只能為Success表達成功,Error表達失敗),resultInfo(結(jié)果提醒)修改密碼接口:http://接口文獻地址/proxy.jsp?action=editPassword&userID=xxx&oldPWD=xxx&newPWD=xxx請求方式:POST接口地址:由合作方提供參數(shù)約定說明:參數(shù)標(biāo)記類型值說明action字符串editPassword接口執(zhí)行的方法名userID字符串用戶IDoldPWD字符串舊密碼newPWD字符串新密碼http響應(yīng)內(nèi)容類型:text/xml應(yīng)響結(jié)果示例:<?xmlversion="1.0"encoding="utf-8"?><root><result>Success</result><resultInfo></resultInfo></root>應(yīng)響結(jié)果說明:輸出保存結(jié)果字段說明:result(結(jié)果,值只能為Success表達成功,Error表達失敗),resultInfo(結(jié)果提醒)解散房間接口:http://接口文獻地址/proxy.jsp?action=dissolveRoom&roomID=xxx&account=xxx&password=xxx請求方式:POST接口地址:由合作方提供參數(shù)約定說明:參數(shù)標(biāo)記類型值說明ac