audiohttperror503

CiscoTelePresenceServerAPI2.
3Page1of82CiscoTelePresenceTelePresenceServerAPI2.
3ProductProgrammingReferenceGuide14970September2012CiscoTelePresenceServerAPI2.
3Page2of82ContentsIntroduction4XML-RPCimplementation4Transportprotocol4ConsideringAPIoverheadwhenwritingapplications4APIChangeSummary5APIreference7Deprecations8Deprecatedparameters8cdrlog.
enumerate8cdrlog.
query11conference.
create11conference.
delete14conference.
enumerate15conference.
invite18conference.
senddtmf23conference.
sendmessage24conference.
sendwarning25conference.
set26conference.
status29conference.
uninvite38device.
query39device.
network.
query40device.
health.
query45device.
restartlog.
query47device.
restart48participant.
diagnostics49participant.
enumerate53participant.
set55participant.
tidylayout57CiscoTelePresenceServerAPI2.
3Page3of82system.
info57Feedbackreceivers60feedbackReceiver.
query60feedbackReceiver.
configure61feedbackReceiver.
reconfigure62feedbackReceiver.
remove64feedbackReceiver.
status64Feedbackmessages65Feedbackevents66APIoverview67Encoding67Authentication67Messageflow68Relatedinformation71system.
xmlfile71ExampleXML-RPCresponsetoparticipant.
diagnostics72Faultcodes77HTTPkeep-alives78Checkingforupdatesandgettinghelp80References81IntroductionCiscoTelePresenceServerAPI2.
3Page4of82IntroductionThisdocumentaccompaniesthelatestversionoftheremotemanagementAPIfortheCiscoTelePresenceServersoftware(respectivelyreferredtoasAPIandTelePresenceServerinthisdocument).
ThefollowingCiscoTelePresenceproductssupportthisAPIwhentheyarerunningTelePresenceServerversion2.
3andlater:nCiscoTelePresenceServerMSE8710nCiscoTelePresenceServer7010XML-RPCimplementationAPIcallsandresponsesareimplementedusingtheXML-RPCprotocol.
ThissimpleprotocoldoesremoteprocedurecallingusingHTTP(orHTTPS)asthetransportandXMLastheencoding,however,itstillallowsforcomplexdatastructures.
XML-RPCisstatelessandisnotplatform-dependent;itwaschoseninfavorofSOAP(SimpleObjectAccessProtocol)becauseofitssimplicity.
Yourapplicationmusteitherregularlypollthedeviceorcontinuallylistentothedevice-ifitisconfiguredtopublishfeedbackevents-ifyouwantittomonitorthedevice'sactivity.
TheAPIimplementsallparametersandreturneddataaselements,eachofwhichisexplicitlynamed.
Forexample,device.
queryreturns(amongstotherdata)thecurrenttimeas:currentTime20110121T13:31:26ratherthansimply20110121T13:31:26Note:Unlessotherwisestated,assumestringshaveamaximumlengthof31characters.
RefertotheXML-RPCspecification[1]formoreinformation.
TransportprotocolThedeviceimplementsHTTP/1.
1asdefinedbyRFC2616[2].
ItexpectstoreceivecommunicationsoverTCP/IPconnectionstoport80(defaultHTTPport)orport443(defaultHTTPSport).
YourapplicationshouldsendHTTPPOSTmessagestotheURLdefinedbypath/RPC2onthedevice'sIPaddress,forexamplehttps://10.
0.
0.
53/RPC2.
YoucanconfigurethedevicetoreceiveHTTPandHTTPSonnon-standardTCPportnumbersifnecessary,inwhichcaseappendthenon-standardportnumbertotheIPaddress.
ConsideringAPIoverheadwhenwritingapplicationsEveryAPIcommandthatyourapplicationsendsincursaprocessingoverheadwithinthedevice'sownapplication.
TheexactamountofoverheadvarieswidelywiththecommandtypeandtheparametersIntroductionCiscoTelePresenceServerAPI2.
3Page5of82sent.
Itisimportanttobearthisinmindwhendesigningyourapplication'sarchitectureandsoftware.
IfthedevicereceivesahighnumberofAPIcommandseverysecond,itsoverallperformancecouldbeseriouslyimpaired–inthesamewaythatitwouldbeifseveralusersaccesseditsimultaneouslyviathewebinterface.
ThereisalimitonthenumberofsimultaneousrequeststhattheTelePresenceServercanprocess.
IfyourclientapplicationreceivesarelatedHTTPerrorsuchas503ServiceUnavailablethenitshouldretrytherequest.
Forthisreason,thebestarchitectureisasingleserverrunningtheAPIapplicationandsendingcommandstothedevice.
Ifmultipleusersneedtousetheapplicationsimultaneously,provideawebinterfaceonthatserverorwriteaclientthatcommunicateswiththeserver.
Theserverwouldthenmanagetheclients'requestsandsendAPIcommandsdirectlytothedevice.
ImplementsomeformofcontrolintheAPIapplicationonyourservertopreventthedevicebeingoverloadedwithAPIcommands.
ThisprovidesmuchmorecontrolthanhavingtheclientssendAPIcommandsdirectlyandwillpreventthedevice'sperformancebeingimpairedbyunmanageablenumbersofAPIrequests.
Furthermore,theAPIisdesignedtohaveaslittleimpactaspossibleonthenetworkwhenrespondingtorequests.
Thedevice'sresponsesdonotroutinelyincludedatathatisnotrelevant,oremptydatastructureswherethedataisnotavailable.
Yourapplicationshouldtakeresponsibilityforcheckingwhethertheresponseincludeswhatyouexpected,andyoushoulddesignittogracefullyhandleanysituationswherethedevicedoesnotrespondwiththeexpecteddata.
APIChangeSummaryThelatestCiscoTelePresenceServerAPIisversion2.
3.
ThetablebelowisasummaryofthechangestotheAPIfromversion2.
2to2.
3.
XML-RPCRequestParameterAddition/Deprecateddevice.
queryAdditiondevice.
network.
queryAdditiondevice.
health.
queryAdditiondevice.
restartlog.
queryAdditiondevice.
restartAdditionFeedbackeventsreceiverModifiedreceiverDeleteddeviceStatusChangedAdditionfeedbackReceiver.
statusreceiverIndexsourceIdentifierreceiverURIsubscribedEventsAdditionconference.
invitecontentIndexautoReconnectAdditionconference.
createpinAdditionIntroductionCiscoTelePresenceServerAPI2.
3Page6of82XML-RPCRequestParameterAddition/Deprecatedconference.
setpinAdditionconference.
statuspinAdditionparticipantList>disconnectReasonstringstimeoutprotocolErrorunreachablenetworkErrorcapabilityNegotiationErrordnsFailureAdditionconference.
enumeratepinAdditionconference.
sendwarningsecondsRemainingAdditionparticipant.
diagnosticsAdditionsystem.
infooperationModelicenseModeAdditionAPIreferenceCiscoTelePresenceServerAPI2.
3Page7of82APIreferenceThisisalistoftheAPIcallssupportedbytheTelePresenceServer.
ForeachAPIcall,thefollowinginformationisprovidedwhereapplicable:nDescriptionofthecall'sfunctionandstatusnAcceptedparametersnReturnedparameters,structureformatsanddatatypesnDeprecatedparametersClickthecallnametoreadadetaileddescriptionofthecall.
ncdrlog.
enumeratencdrlog.
querynconference.
createnconference.
deletenconference.
enumeratenconference.
invitenconference.
senddtmfnconference.
sendmessagenconference.
sendwarningnconference.
setnconference.
statusnconference.
uninvitendevice.
health.
queryndevice.
network.
queryndevice.
queryndevice.
restartlog.
queryndevice.
restartnfeedbackReceiver.
configurenfeedbackReceiver.
querynfeedbackReceiver.
reconfigurenfeedbackReceiver.
removenfeedbackReceiver.
statusnparticipant.
diagnosticsnparticipant.
enumeratenparticipant.
setnparticipant.
tidylayoutnsystem.
infoAPIreferenceCiscoTelePresenceServerAPI2.
3Page8of82DeprecationsDeprecatedparametersThefollowingparametersweredeprecatedinversion2.
2oftheAPI.
Updateyourapplicationstousethereplacementparametersinstead;theseparametersmaynotbesupportedinfuturereleases.
Incallsthatcanstillacceptthedeprecatedparameters,takecaretosendonlythedeprecatedparameterorthereplacementparameter;notboth.
DeprecatedparameterReplacedbyTheaffectedcallspermanentpersistentconference.
createconferenceIDconferenceGUIDconference.
inviteconference.
createconference.
deleteconference.
enumerateconference.
senddtmfconference.
sendmessageconference.
sendwarningconference.
setconference.
statusconference.
uninviteparticipant.
enumerateparticipantList(string)participants(array)conference.
inviteparticipantIDparticipantGUIDconference.
inviteconference.
senddtmfconference.
sendmessageconference.
statusparticipant.
enumerateparticipant.
setparticipant.
tidylayoutomitIDomitGUIDconference.
senddtmfendpointTypeendpointCategoryconference.
statusparticipantListIDparticipantListGUIDconference.
uninviteroundTableEnableoneTableModeconference.
setconference.
statuscdrlog.
enumerateStatus:activeThiscallallowsthecallingapplicationtodownloadCDRlogdatawithouthavingtoreturntheentireCDRlog.
ThecallreturnsasubsetoftheCDRlogbasedontheoptionalfilter,indexandnumEventsparameters.
APIreferenceCiscoTelePresenceServerAPI2.
3Page9of82TheTelePresenceServerholdsupto2000recordsinmemory.
Itdoesnotpermanentlyretainthese,sowerecommendthatyourapplicationeithermakesregularenumeratecallsortriggersenumeratecallsuponreceivingthecdrAddedfeedbackevent.
Accepts:Optional:filterType:arrayAnarrayofstrings,eachofwhichisthenameofaneventtypebywhichtofiltertheresponse.
Ifthearrayisomitted,alleventtypesarereturned.
FortheTelePresenceServer,thecallcanrequestany/allofthefollowingeventtypes:nconferenceStartednconferenceActivenparticipantConnectednparticipantJoinednparticipantMediaSummarynparticipantLeftnparticipantDisconnectednconferenceInactivenconferenceFinishedindexType:integerIndexfromwhichtogetevents.
ThedevicereturnsthenextIndexsotheapplicationcanuseittoretrievethenextenumerationofCDRdata.
Ifindexisomitted,negative,orgreater(by2ormore)thanthehighestindex,thenthedevicewillenumerateeventsfromthebeginningoftheCDRlog.
numEventsType:integerSpecifiesmaximumnumberofeventstobereturnedperenumeration.
Ifomitted(ornotbetween1-20inclusive),amaximumof20eventswillbereturnedperenumeration.
Returns:Theresponseprovidesreferenceinformationsuchastimeandlogposition,andanarrayofeventsthatmeettheparametersprovidedinthecall.
startIndexType:integerAPIreferenceCiscoTelePresenceServerAPI2.
3Page10of82Eithertheindexprovided,orifthatislowerthantheindexofthefirstrecordthedevicehas,itwillbethefirstrecorditdoesknowabout.
Inthiscase,comparingthestartIndexwiththeindexprovidedgivesthenumberofdroppedrecords.
nextIndexType:integerRevisionnumberofthedatabeingprovided,reusableinasubsequentcalltotheAPI.
eventsRemainingType:booleanWhetherthereisdataremainingafterthis.
Providedtoavoidputtingalldatainasinglecall.
currentTimeType:dateTime.
iso8601Thesystem'scurrenttime(UTC).
eventsType:arrayListofthenewevents;thesearestructureswithsomecommonfields(time,type,index)andotherfieldsspecifictotheeventtype.
eventsarrayThefollowingparametersarecommontoallCDRlogevents.
Thearrayalsocontainsinformationmembersspecifictoeachevent.
TheCDRlogreferenceguide[3]containsdetailsoftheTelePresenceServereventtypes.
Note:TheCDRlogreferenceguidedescribestheCDRloginitsXMLform,asdownloadedincdr_log.
xmlviathewebinterface.
Whenthesameeventsareenumeratedwiththiscall,theeventtypenamesusecamelCaseformultiplewordsratherthanusingunderscores.
Forexample,conference_startedincdr_log.
xmlisthesameeventtypeasconferenceStartedinthisarray.
Iftherearenoeventstoenumerate,theeventsarrayisreturnedempty.
timeType:dateTime.
iso8601Thedateandtimewhentheeventwaslogged.
ValueDescription20110119T13:52:42yyyymmddThh:mm:sstypeType:stringThenameoftheeventtype.
APIreferenceCiscoTelePresenceServerAPI2.
3Page11of82indexType:integerAnumberthatidentifiesthepositionoftheitemincontextwithsimilaritems.
cdrlog.
queryStatus:activeThiscallqueriesforstatisticsabouttheCDRlog.
Thiscalltakesnoparameters.
Returns:firstIndexType:integerTheindexoftheoldeststoredevent.
numEventsType:integerThetotalnumberofeventsstored.
conference.
createStatus:activeCreatesaconferencewiththespecifiednameandothersuppliedparameters,andreturnstheuniqueidentifierofthenewconference.
Accepts:Required:conferenceNameType:string(upto80characters)ThenamethatreferstotheconferencethatisthesubjectofyourcallortheresponsefromtheTelePresenceServer.
Optional:Usepersistentinsteadofpermanenttodefineconferencepersistence,eventhoughtheTelePresenceServerwillaccepteither.
persistentType:booleanAPIreferenceCiscoTelePresenceServerAPI2.
3Page12of82Defineswhethertheconferencepersistsafterallparticipantsleave.
Persistentconferencesarestoredintheconfigurationfileandthuswillpersistthroughadevicerestart.
ValueDescriptiontrueTheconferencepersists,irrespectiveofparticipantsleaving,untilitisexplicitlydeleted.
falseTheconferenceisdeleted30secondsafterallparticipantshaveleft,orwhendurationexpires(ifitisset).
permanentType:booleanDeprecated.
Usepersistentinstead.
Defineswhethertheconferencepersistsafterallparticipantsleave.
Withoutthisoptionanyconferenceswillbeautomaticallydeletedafter30seconds,orwhendurationexpires(ifitisset).
lockedType:booleanDefineswhethertheconferenceislocked.
Endpointscannotjoinalockedconferencebuttheconferencecaninvitethemin.
ValueDescriptiontrueTheconferenceislocked.
falseTheconferenceisnotlocked.
lockDurationType:integerTheperiodoftime(inseconds)fromnowuntiltheconferencelockexpires.
Requiresthatlockedistrueandignoredotherwise.
numericIDType:string(upto80characters)UsedforregistrationwithH.
323gatekeeper/SIPregistrar,andtodialintotheconference.
registerWithGatekeeperType:booleanDefineswhetherornotthisitemregistersitsnumericIDwiththeH.
323gatekeeper.
registerWithSIPRegistrarType:booleanDefineswhetherornotthisitemregistersitsnumericIDwiththeSIPregistrar.
APIreferenceCiscoTelePresenceServerAPI2.
3Page13of82tsURIType:string(upto80characters)TheaddressthatCiscoTelePresenceSystemT3systemsusetomakeAPIcallstotheTelePresenceServer.
Thisstringmusttaketheform[://][:],forexample,http://mytps:80.
Ifsupplied,thisURIwillbepassedtoallT3systemsintheconferenceviaTString.
Ifnotexplicitlysupplied,theTelePresenceServerwillcreateatsURIbasedonitsIPaddress.
httpandhttpsprotocolsaresupported.
TheTelePresenceServerdoesnotassumeprotocolorportinformationiftheapplicationdoesnotsupplytheminthisstring.
h239ContributionEnabledType:booleanDefineswhethertheconferenceallowscontentcontribution.
Thisparametercontrolswhethercontentmaybecontributedviaanyofthesupportedcontentprotocols;itisnotlimitedtoH.
239.
useLobbyScreenType:booleanDefineswhethertheconferenceshowsthelobbyscreen.
lobbyMessageType:string(upto500characters)Thelobbyscreenmessage.
useWarningType:booleanDefineswhethertheconferencesends'Thisconferenceisabouttoend'warning.
audioPortLimitType:integerThelimitonthenumberofaudioportsthisconferencemayallow.
videoPortLimitType:integerThelimitonthenumberofvideoportsthisconferencemayallow.
durationType:integerPeriodoftime(inseconds)untiltheconferenceendsandisdeleted.
Thisparameterisnotallowedifpersistentistrue.
APIreferenceCiscoTelePresenceServerAPI2.
3Page14of82pinType:string(upto40characters)ThePINforthisconference.
Ifassociatedwithaconference,itisastringofnumericdigitsthatmustbeenteredtogainaccesstothatconference.
Note:APINisonlyvalidforincomingcalls—nooutgoingcallswilleverneedtoenterit.
Asaresultofthis,aconferencePINcanonlybesetwhentheconferencehasanumericID.
TryingtosetaPINwithoutanumericIDwillreturnafault,andclearingaconference'snumericIDwillalsoclearthatconference'sPIN.
Returns:conferenceGUIDType:stringGloballyuniqueidentifieroftheconference.
conferenceIDType:integerDeprecated.
UseconferenceGUIDinstead.
Uniqueconferenceidentifier.
conference.
deleteStatus:activeDeletesthespecifiedconference.
Accepts:Required:Toidentifytheconference,useconferenceGUIDinsteadofconferenceID,notboth.
conferenceGUIDType:stringGloballyuniqueidentifieroftheconference.
conferenceIDType:integerDeprecated.
UseconferenceGUIDinstead.
Uniqueconferenceidentifier.
APIreferenceCiscoTelePresenceServerAPI2.
3Page15of82conference.
enumerateStatus:activeRequestsinformationaboutalltheconferencesontheTelePresenceServer.
Thefullenumerationresponsemayrequiremultiplecalls.
Accepts:Optional:enumerateIDType:integerEnumeratecallsmayreturnmanyresultssoallofthemwillacceptthisparameterandmayincludethisparameterintheresponse.
IftheresponseincludesanenumerateID,theapplicationshouldpasstheIDtothesubsequentenumeratecalltoretrievethenextsetofresults.
IftheresponsedoesnotincludeanenumerateID,therearenomoreresultsintheenumeration.
IftheapplicationomitstheenumerateID,thetargetdevicewillstartanewenumerationandreturnthefirstsetofresults.
activeFilterType:booleanValueDescriptiontrueRequestonlyactiveconferencesfalseRequestallconferences.
Thisisthedefaultvalue;itisassumedifyouomittheparameter.
Returns:Iftherearenoconferencestoenumerate,thentheconference.
enumeratecalldoesnotreturntheconferencesarray.
Conditional:enumerateIDType:integerEnumeratecallsmayreturnmanyresultssoallofthemwillacceptthisparameterandmayincludethisparameterintheresponse.
IftheresponseincludesanenumerateID,theapplicationshouldpasstheIDtothesubsequentenumeratecalltoretrievethenextsetofresults.
IftheresponsedoesnotincludeanenumerateID,therearenomoreresultsintheenumeration.
APIreferenceCiscoTelePresenceServerAPI2.
3Page16of82IftheapplicationomitstheenumerateID,thetargetdevicewillstartanewenumerationandreturnthefirstsetofresults.
conferencesType:arrayAnarrayofstructs,eachofwhichcontainsallthereturnedinformationaboutasingleconference.
conferencesarraymembersThefollowinginformationisreturnedabouttheenumeratedconferences:conferenceNameType:string(upto80characters)ThenamethatreferstotheconferencethatisthesubjectofyourcallortheresponsefromtheTelePresenceServer.
conferenceGUIDType:stringGloballyuniqueidentifieroftheconference.
conferenceIDType:integerDeprecated.
UseconferenceGUIDinstead.
Uniqueconferenceidentifier.
TheTelePresenceServerreturnsthisparameter,eventhoughitisdeprecated,toensureapplicationcompatibilityintheshortterm.
Werecommendthatyouusethereplacementparameterinstead.
activeType:booleanValueDescriptiontrueTheconferenceiscurrentlyactivefalseTheconferenceiscurrentlyinactive(e.
g.
apersistentconferencewithoutanyactiveparticipants,oranon-persistentconferencethathasnotyetstartedorisemptybutnotyetdeleted)persistentType:booleanDefineswhethertheconferencepersistsafterallparticipantsleave.
Persistentconferencesarestoredintheconfigurationfileandthuswillpersistthroughadevicerestart.
APIreferenceCiscoTelePresenceServerAPI2.
3Page17of82ValueDescriptiontrueTheconferencepersists,irrespectiveofparticipantsleaving,untilitisexplicitlydeleted.
falseTheconferenceisdeleted30secondsafterallparticipantshaveleft,orwhendurationexpires(ifitisset).
lockedType:booleanDefineswhethertheconferenceislocked.
Endpointscannotjoinalockedconferencebuttheconferencecaninvitethemin.
ValueDescriptiontrueTheconferenceislocked.
falseTheconferenceisnotlocked.
numericIDType:string(upto80characters)UsedforregistrationwithH.
323gatekeeper/SIPregistrar,andtodialintotheconference.
Thisisanemptystringiftheparameterisnotset.
registerWithGatekeeperType:booleanDefineswhetherornotthisitemregistersitsnumericIDwiththeH.
323gatekeeper.
registerWithSIPRegistrarType:booleanDefineswhetherornotthisitemregistersitsnumericIDwiththeSIPregistrar.
h239ContributionEnabledType:booleanDefineswhethertheconferenceallowscontentcontribution.
Thisparametercontrolswhethercontentmaybecontributedviaanyofthesupportedcontentprotocols;itisnotlimitedtoH.
239.
pinType:string(upto40characters)ThePINforthisconference.
Ifassociatedwithaconference,itisastringofnumericdigitsthatmustbeenteredtogainaccesstothatconference.
APIreferenceCiscoTelePresenceServerAPI2.
3Page18of82Note:APINisonlyvalidforincomingcalls—nooutgoingcallswilleverneedtoenterit.
Asaresultofthis,aconferencePINcanonlybesetwhentheconferencehasanumericID.
TryingtosetaPINwithoutanumericIDwillreturnafault,andclearingaconference'snumericIDwillalsoclearthatconference'sPIN.
conference.
inviteStatus:activeInvitesthespecifiedparticipantstothespecifiedconference.
AvoidusingtheconferenceIDandparticipantListparametersandusethereplacementconferenceGUIDandparticipantsparametersinstead.
Accepts:Required:Toidentifytheconference,useconferenceGUIDinsteadofconferenceID,notboth.
Toidentifytheparticipants,usetheparticipantsarrayinsteadofparticipantList,notboth.
conferenceGUIDType:stringGloballyuniqueidentifieroftheconference.
conferenceIDType:integerDeprecated.
UseconferenceGUIDinstead.
Uniqueconferenceidentifier.
participantListType:stringDeprecated.
Useparticipantsarrayinstead.
Acommaseparatedlistofparticipantaddresses,withoptionalextrainformation.
ValueDescriptionExample10.
2.
171.
232,10.
47.
2.
246,h323:numericID@domain.
comExamplewithtype10.
2.
171.
232,t3:h323:numericID@domain.
com(specifytheendpointtype,followedbyacolon,beforetheprotocol)Examplewithmaster10.
2.
171.
232,t3:master:h323:numericID@domain.
com(specifymaster:intheprefix;immediatelyaftertheendpointtype,ifpresent,andbeforetheprotocol)APIreferenceCiscoTelePresenceServerAPI2.
3Page19of82participantsType:arrayAnarrayofstructuresthatrepresentparticipants.
participantsarrayYoumustincludeanarrayofparticipantsinyourconference.
invitecall.
Eachparticipantmusthaveanaddressparameter.
AllparticipantparametersexceptaddressareoptionalandtheTelePresenceServerwillusethedefaultvalueifyourcallomitsthem.
addressType:stringTheaddressoftheitem,e.
g.
endpointorgateway;maybehostname,IPaddressorE.
164number.
Youmustprefixtheaddresswitheitherh323:orsip:.
Ifyoudonotprovideaprefix,theTelePresenceServerattemptstocalltheaddressdirectly,usingH.
323(notviathegatekeeper).
Themaximumlengthoftheaddressis80characters(notethatprefixessuchash323:areincludedinthislimit).
Youmayprovideacommaseparatedlistofuptofouraddressesifyouareinvitingagroupedendpoint(requiresathird-partyinteropfeaturekeyinstalledontheTelePresenceServer).
Inthiscaseyoushouldprovideaprotocolprefixforeachaddress,forexampleh323:leftmost_endpoint@domain.
com,h323:rightmost_endpoint@domain.
com,butmustnotsupplyatypeprefix.
Themaximumlengthofeachaddressis80characters(notethatprefixessuchash323:areincludedinthislimit).
Thetotallengthofthevaluesupplied(uptofouraddressesandseparatingcommas)cannotexceed323characters.
typeType:stringSpecifiesthetypeofendpoint.
ValueDescriptiont3CiscoTelePresenceSystemT3ctsAnyCiscoTelePresenceSystem'telepresence'endpoint(1or3screen,e.
g.
500,1300,3000)cts1CiscoTelePresenceSystemsinglescreen'telepresence'endpoints(e.
g.
500and1300series)cts3CiscoTelePresenceSystemthreescreen'telepresence'endpoints(e.
g.
3000series)masterAPIreferenceCiscoTelePresenceServerAPI2.
3Page20of82Type:booleanValueDescriptiontrueThisendpointisconferencemasterfalse(defaultifomitted)ThisendpointisnottheconferencemasteroneTableIndexType:integerTheendpoint'spositionifitisinaOneTableconference.
Appliesonlyiftypeist3.
ValueDescription1,2,3,or4PositionindexoftheendpointwhenitisinOneTablemode.
Thepositionsincrementaroundtheonevirtualtableinaclockwisemanner,whenthetableisviewedfromabove.
Forexample,theparticipantwhoseindexis2willappeartobesittingtotheleftoftheparticipantwhoseindexis1.
maxBitRateType:integerThemaximumbitrate,inkbps,inbothdirectionsbetweentheTelePresenceServerandthisparticipant.
TheTelePresenceServerusesitsdefaultsettingifyourcallomitsthisparameter.
recordingDeviceType:booleanValueDescriptiontrueTheendpointistreatedasarecordingdevice;itdoesnotfeatureinthelayoutandotherparticipantsaremadeawareofitspresencebyareddotasappropriate.
false(defaultifomitted)Theendpointisanormalendpoint.
dtmfType:string(upto50characters)DTMFcharacterstringtosendtothisendpointafterconnection.
audioContentIndexType:integerDefineswhichendpointinagroupshouldreceivethecontentandaudio.
Thisisazero-basedindexthatcorrespondstotheentriesprovidedinthecommaseparatedlistofendpointaddressesinaddress.
APIreferenceCiscoTelePresenceServerAPI2.
3Page21of82ValueDescription0(default)Thefirstaddressintheaddressstringn-1(maximum)ThelastaddressinacommaseparatedstringofnaddressescontentIndexType:integerDefineswhichendpointinagroupshouldreceivethecontent(ifdifferenttoaudioContentIndex).
ItisignoredunlessaudioContentIndexissuppliedintherequest.
Thisisazero-basedindexthatcorrespondstotheentriesprovidedinthecommaseparatedlistofendpointaddressesinaddress.
DefaultstoaudioContentIndex.
ValueDescription0(default)Thefirstaddressintheaddressstringn-1(maximum)ThelastaddressinacommaseparatedstringofnaddressesUsethisparameteriftheendpointsending/receivingcontentisdifferenttothatsending/receivingaudio(specifiedinaudioContentIndex).
camerasCrossedType:booleanValueDescriptiontrueThecamerasofagroupedendpointarecrossed;thisisignoredunlessthisparticipantisagroupedendpoint,i.
e.
hasmultipleaddressparametersfalse(defaultifomitted)ThecamerasarenotcrossedtxAspectRatioType:stringOverridestheaspectratioofthelayouttransmittedtothisparticipant.
ValueDescriptiononly16to9ForcetheTelePresenceServertosendawidescreenlayout(16:9)totheendpoint,overridinganybox-wideorper-endpointsettingsonly4to3ForcetheTelePresenceServertosenda4:3layouttotheendpoint,overridinganybox-wideorper-endpointsettingsautoReconnectType:booleanAPIreferenceCiscoTelePresenceServerAPI2.
3Page22of82DefineswhethertheTelePresenceServerattemptstore-establishthecalltothisendpoint(oramemberofagroupiftheendpointisgrouped),ifitfailsordisconnectsduetoanerror.
ValueDescriptionTrueFiveretrieswillbeattemptedatintervalsof5seconds(firstretryafterfailure/disconnection),15seconds,30seconds,60seconds,120seconds.
FalseTheTelePresenceServerwillnotattempttoreconnectthecall.
Thisisthedefault.
Returns:participantListType:arrayArrayofparticipants.
EachmemberofthearrayisastructthatrepresentsaparticipantontheTelePresenceServer.
participantListarraymembersThereturnedparticipantListisanarrayofsuccessfullyinvitedparticipants.
NotethatthememberstructsofthisarrayaredifferenttothosereturnedinparticipantListbytheconference.
statuscall.
Eachstructcontainsthefollowingparameters:participantGUIDType:stringTheGUIDofthisparticipant,assignedbytheTelePresenceServer.
participantIDType:integerDeprecated.
UseparticipantGUIDinstead.
TheuniqueIDofthisparticipant,assignedbytheTelePresenceServer.
TheTelePresenceServerreturnsthisparameter,eventhoughitisdeprecated,toensureapplicationcompatibilityintheshortterm.
Werecommendthatyouusethereplacementparameterinstead.
addressType:stringTheaddressoftheitem,e.
g.
endpointorgateway;maybehostname,IPaddressorE.
164number.
Theseaddressesareasyousuppliedthemintheparticipantsarray,tomakethemeasiertocompare.
APIreferenceCiscoTelePresenceServerAPI2.
3Page23of82conference.
senddtmfStatus:activeSendsaDTMFstringtosomeorallparticipantsinthespecifiedconference.
YoumustspecifytheconferenceandtheDTMFstring(upto50characters).
Ifyoudon'tspecifyaparticipant,thestringgoestoallparticipants;otherwise,youmayspecifyeitheraparticipantwhowillreceivethestringoronewhowillnotreceivethestring.
Accepts:Required:Toidentifytheconference,useconferenceGUIDinsteadofconferenceID,notboth.
conferenceGUIDType:stringGloballyuniqueidentifieroftheconference.
conferenceIDType:integerDeprecated.
UseconferenceGUIDinstead.
Uniqueconferenceidentifier.
dtmfType:string(upto50characters)DTMFcharacterstringtosendtothisendpointafterconnection.
Optional:ToidentifytheparticipanttoreceiveDTMF,useparticipantGUIDinsteadofparticipantID,notboth.
Alternatively,toidentifytheparticipantwhowon'treceiveDTMF,useomitGUIDinsteadofomitID,notboth.
participantGUIDType:stringTheGUIDofthisparticipant,assignedbytheTelePresenceServer.
Ifyousupplythisparameter,theDTMFstringwillbesenttothisparticipantonly.
participantIDType:integerDeprecated.
UseparticipantGUIDinstead.
TheuniqueIDofthisparticipant,assignedbytheTelePresenceServer.
APIreferenceCiscoTelePresenceServerAPI2.
3Page24of82omitGUIDType:stringAparticipantGUID.
PreventsthisparticipantfromreceivingtheDTMFstringspecifiedindtmf.
Ifyousupplythisparameter,theDTMFstringwillbesenttoallparticipantsexceptthisone.
IfparticipantGUIDispresent,omitGUIDisignored.
omitIDType:integerDeprecated.
UseomitGUIDinstead.
AparticipantID.
PreventsthisparticipantfromreceivingtheDTMFstringspecifiedindtmf.
conference.
sendmessageStatus:activeSendsamessagetoallparticipantsinthespecifiedconference.
Youmustspecifytheconferenceandthemessage.
Ifyouchoosetospecifyaparticipant,themessagewillonlygotothatparticipant.
Accepts:Required:Toidentifytheconference,useconferenceGUIDinsteadofconferenceID,notboth.
conferenceGUIDType:stringGloballyuniqueidentifieroftheconference.
conferenceIDType:integerDeprecated.
UseconferenceGUIDinstead.
Uniqueconferenceidentifier.
messageType:string(upto500characters)Messagetosendtoconference.
Optional:Toidentifyaparticipant,usetheparticipantGUIDinsteadofparticipantID,notboth.
participantGUIDAPIreferenceCiscoTelePresenceServerAPI2.
3Page25of82Type:stringTheGUIDofthisparticipant,assignedbytheTelePresenceServer.
participantIDType:integerDeprecated.
UseparticipantGUIDinstead.
TheuniqueIDofthisparticipant,assignedbytheTelePresenceServer.
positionType:integerDefineswherethemessagedisplaysonthelayout.
ValueDescription1,2,or3Themessagedisplaysnearthetopofthelayout;alignedtotheleft,center,orrightrespectively.
4,5(default),or6Themessagedisplaysinthemiddleofthelayout;alignedtotheleft,center,orrightrespectively.
7,8,or9Themessagedisplaysnearthebottomofthelayout;alignedtotheleft,center,orrightrespectively.
durationType:integerPeriodoftime(inseconds)forwhichthemessageisdisplayedtoparticipants.
Defaultis30.
conference.
sendwarningStatus:activeSendsthe'conferenceisabouttoend'warningtoalltheparticipantsinthespecifiedconference.
Accepts:Required:Toidentifytheconference,useconferenceGUIDinsteadofconferenceID,notboth.
conferenceGUIDType:stringGloballyuniqueidentifieroftheconference.
conferenceIDType:integerAPIreferenceCiscoTelePresenceServerAPI2.
3Page26of82Deprecated.
UseconferenceGUIDinstead.
Uniqueconferenceidentifier.
Optional:secondsRemainingType:integerThenumberofsecondsfromnowinwhichtheconferencewillend.
ThisvalueisusedwheninformingCTSendpoints(usingCCCP)thattheconferenceisending.
conference.
setStatus:activeEdittheconfigurationofthespecifiedconference.
Accepts:Required:Toidentifytheconference,useconferenceGUIDinsteadofconferenceID,notboth.
conferenceGUIDType:stringGloballyuniqueidentifieroftheconference.
conferenceIDType:integerDeprecated.
UseconferenceGUIDinstead.
Uniqueconferenceidentifier.
Optional:Tosetuponetablemode,useoneTableModeinsteadofroundTableEnable,notboth.
numericIDType:string(upto80characters)UsedforregistrationwithH.
323gatekeeper/SIPregistrar,andtodialintotheconference.
registerWithGatekeeperType:booleanDefineswhetherornotthisitemregistersitsnumericIDwiththeH.
323gatekeeper.
registerWithSIPRegistrarAPIreferenceCiscoTelePresenceServerAPI2.
3Page27of82Type:booleanDefineswhetherornotthisitemregistersitsnumericIDwiththeSIPregistrar.
roundTableEnableType:booleanDeprecated.
UseOneTableModeinstead.
Defineswhethertheconferenceisinroundtablemode.
IfyousupplybothroundTableEnableandOneTableMode,thentheTelePresenceServerwilluseOneTableModewithoutreturninganerror.
oneTableModeType:integerValueDescription0OneTableModeoff14personOneTableModeh239ContributionEnabledType:booleanDefineswhethertheconferenceallowscontentcontribution.
Thisparametercontrolswhethercontentmaybecontributedviaanyofthesupportedcontentprotocols;itisnotlimitedtoH.
239.
lockedType:booleanDefineswhethertheconferenceislocked.
Endpointscannotjoinalockedconferencebuttheconferencecaninvitethemin.
ValueDescriptiontrueTheconferenceislocked.
falseTheconferenceisnotlocked.
lockDurationType:integerTheperiodoftime(inseconds)fromnowuntiltheconferencelockexpires.
Requiresthatlockedistrueandignoredotherwise.
durationType:integerPeriodoftime(inseconds)untiltheconferenceendsandisdeleted.
APIreferenceCiscoTelePresenceServerAPI2.
3Page28of82Thisparameterisnotallowedifpersistentistrue.
Youcanpassanegativevaluetoclearapreviouslysetduration.
audioPortLimitSetType:booleanDefineswhethertheaudioPortLimitisapplied.
ValueDescriptiontrueLimitsthenumberofaudioportstothevalueinaudioPortLimitfalseaudioPortLimitisignoredifitispresentYoumustprovideanaudioPortLimitifyousetaudioPortLimitSettotrue.
Ifyousetitfalse,thecallclearstheexistingaudioPortLimit.
audioPortLimitType:integerThelimitonthenumberofaudioportsthisconferencemayallow.
videoPortLimitSetType:booleanDefineswhetherthevideoPortLimitisapplied.
ValueDescriptiontrueLimitsthenumberofvideoportstothevalueinvideoPortLimitfalsevideoPortLimitisignoredifitispresentYoumustprovideavideoPortLimitifyousetvideoPortLimitSettotrue.
Ifyousetitfalse,thecallclearstheexistingvideoPortLimit.
videoPortLimitType:integerThelimitonthenumberofvideoportsthisconferencemayallow.
useLobbyScreenType:booleanDefineswhethertheconferenceshowsthelobbyscreen.
lobbyMessageType:string(upto500characters)Thelobbyscreenmessage.
useWarningAPIreferenceCiscoTelePresenceServerAPI2.
3Page29of82Type:booleanDefineswhethertheconferencesends'Thisconferenceisabouttoend'warning.
pinType:string(upto40characters)ThePINforthisconference.
Ifassociatedwithaconference,itisastringofnumericdigitsthatmustbeenteredtogainaccesstothatconference.
Note:APINisonlyvalidforincomingcalls—nooutgoingcallswilleverneedtoenterit.
Asaresultofthis,aconferencePINcanonlybesetwhentheconferencehasanumericID.
TryingtosetaPINwithoutanumericIDwillreturnafault,andclearingaconference'snumericIDwillalsoclearthatconference'sPIN.
conference.
statusStatus:activeReportsthecurrentstatusofthespecifiedconferenceanditsparticipants.
Accepts:Required:Toidentifytheconference,useconferenceGUIDinsteadofconferenceID,notboth.
conferenceGUIDType:stringGloballyuniqueidentifieroftheconference.
conferenceIDType:integerDeprecated.
UseconferenceGUIDinstead.
Uniqueconferenceidentifier.
Optional:enumerateIDType:integerEnumeratecallsmayreturnmanyresultssoallofthemwillacceptthisparameterandmayincludethisparameterintheresponse.
IftheresponseincludesanenumerateID,theapplicationshouldpasstheIDtothesubsequentenumeratecalltoretrievethenextsetofresults.
IftheresponsedoesnotincludeanenumerateID,therearenomoreresultsintheenumeration.
APIreferenceCiscoTelePresenceServerAPI2.
3Page30of82IftheapplicationomitstheenumerateID,thetargetdevicewillstartanewenumerationandreturnthefirstsetofresults.
Returns:conferenceGUIDType:stringGloballyuniqueidentifieroftheconference.
conferenceIDType:integerDeprecated.
UseconferenceGUIDinstead.
Uniqueconferenceidentifier.
TheTelePresenceServerreturnsthisparameter,eventhoughitisdeprecated,toensureapplicationcompatibilityintheshortterm.
Werecommendthatyouusethereplacementparameterinstead.
activeType:booleanValueDescriptiontrueTheconferenceiscurrentlyactivefalseTheconferenceiscurrentlyinactive(e.
g.
apersistentconferencewithoutanyactiveparticipants,oranon-persistentconferencethathasnotyetstartedorisemptybutnotyetdeleted)persistentType:booleanDefineswhethertheconferencepersistsafterallparticipantsleave.
Persistentconferencesarestoredintheconfigurationfileandthuswillpersistthroughadevicerestart.
ValueDescriptiontrueTheconferencepersists,irrespectiveofparticipantsleaving,untilitisexplicitlydeleted.
falseTheconferenceisdeleted30secondsafterallparticipantshaveleft,orwhendurationexpires(ifitisset).
durationType:integerPeriodoftime(inseconds)untiltheconferenceendsandisdeleted.
Thisparameterisnotallowedifpersistentistrue.
APIreferenceCiscoTelePresenceServerAPI2.
3Page31of82lockedType:booleanDefineswhethertheconferenceislocked.
Endpointscannotjoinalockedconferencebuttheconferencecaninvitethemin.
ValueDescriptiontrueTheconferenceislocked.
falseTheconferenceisnotlocked.
lockDurationType:integerTheperiodoftime(inseconds)fromnowuntiltheconferencelockexpires.
Requiresthatlockedistrueandignoredotherwise.
roundTableEnableType:booleanDeprecated.
UseOneTableModeinstead.
Defineswhethertheconferenceisinroundtablemode.
TheTelePresenceServerreturnsthisparameter,eventhoughitisdeprecated,toensureapplicationcompatibilityintheshortterm.
Werecommendthatyouusethereplacementparameterinstead.
oneTableModeType:integerValueDescription0OneTableModeoff14personOneTableModeh239ContributionIDType:integerTheparticipantIDoftheendpointthatiscontributingH.
239content.
ZeroifthereisnoH.
239contribution.
portsVideoFreeType:integerCountofthecurrentlyunusedvideoports.
Zeroiftheconferenceisinactive.
portsAudioFreeAPIreferenceCiscoTelePresenceServerAPI2.
3Page32of82Type:integerCountofthecurrentlyunusedaudioports.
Zeroiftheconferenceisinactive.
portsContentFreeType:integerCountofthecurrentlyunusedcontentports.
Zeroiftheconferenceisinactive.
numericIDType:string(upto80characters)UsedforregistrationwithH.
323gatekeeper/SIPregistrar,andtodialintotheconference.
Thisisanemptystringiftheparameterisnotset.
pinType:string(upto40characters)ThePINforthisconference.
Ifassociatedwithaconference,itisastringofnumericdigitsthatmustbeenteredtogainaccesstothatconference.
Note:APINisonlyvalidforincomingcalls—nooutgoingcallswilleverneedtoenterit.
Asaresultofthis,aconferencePINcanonlybesetwhentheconferencehasanumericID.
TryingtosetaPINwithoutanumericIDwillreturnafault,andclearingaconference'snumericIDwillalsoclearthatconference'sPIN.
registerWithGatekeeperType:booleanDefineswhetherornotthisitemregistersitsnumericIDwiththeH.
323gatekeeper.
registerWithSIPRegistrarType:booleanDefineswhetherornotthisitemregistersitsnumericIDwiththeSIPregistrar.
recordingType:booleanTrueifthisconferenceisbeingrecordedbyarecordingdevicespecifiedinconference.
invite.
audioPortLimitSetType:booleanDefineswhethertheaudioPortLimitisapplied.
APIreferenceCiscoTelePresenceServerAPI2.
3Page33of82ValueDescriptiontrueLimitsthenumberofaudioportstothevalueinaudioPortLimitfalseaudioPortLimitisignoredifitispresentaudioPortLimitType:integerThelimitonthenumberofaudioportsthisconferencemayallow.
Thismaybereturnedas0,eventhoughtheaudioportsarenotlimitedto0,unlessaudioPortLimitSetistrue.
videoPortLimitSetType:booleanDefineswhetherthevideoPortLimitisapplied.
ValueDescriptiontrueLimitsthenumberofvideoportstothevalueinvideoPortLimitfalsevideoPortLimitisignoredifitispresentvideoPortLimitType:integerThelimitonthenumberofvideoportsthisconferencemayallow.
Thismaybereturnedas0,eventhoughthevideoportsarenotlimitedto0,unlessvideoPortLimitSetistrue.
participantListType:arrayArrayofparticipants.
EachmemberofthearrayisastructthatrepresentsaparticipantontheTelePresenceServer.
participantListarraymembersThereturnedparticipantListisanarrayoftheconference'sparticipants.
NotethatthememberstructsofthisarrayaredifferenttothosereturnedinparticipantListbytheconference.
invitecall.
Iftherearenoparticipantsinthisconference,theparticipantListarrayisreturnedempty.
Note:itisonlyreturnedemptyifnoparticipantshavejoinedtheconferencesincetheTelePresenceServerstarteduportherearenoactiveparticipantsandtheClearpreviousparticipantsrecordbuttononthewebinterfacehasbeenclicked.
Otherwiseitwilllistdisconnectedparticipants.
Eachstructcontainsthefollowingparameters:APIreferenceCiscoTelePresenceServerAPI2.
3Page34of82participantGUIDType:stringTheGUIDofthisparticipant,assignedbytheTelePresenceServer.
participantIDType:integerDeprecated.
UseparticipantGUIDinstead.
TheuniqueIDofthisparticipant,assignedbytheTelePresenceServer.
TheTelePresenceServerreturnsthisparameter,eventhoughitisdeprecated,toensureapplicationcompatibilityintheshortterm.
Werecommendthatyouusethereplacementparameterinstead.
callStateType:integerStateofthecallbetweentheTelePresenceServerandthisparticipant.
ValueDescription0Notconnected1Callingin(notyetinconference)2Calledinandparticipating3Callingout(notyetinconference)4CalledoutandparticipatingendpointTypeType:integerDeprecated:useendpointCategoryinstead.
ValueDescription1Normalendpoint3Groupedendpoints4T35CiscoCTSorotherTIPcapableendpointsTheTelePresenceServerreturnsthisparameter,eventhoughitisdeprecated,toensureapplicationcompatibilityintheshortterm.
Werecommendthatyouusethereplacementparameterinstead.
endpointCategoryType:stringAPIreferenceCiscoTelePresenceServerAPI2.
3Page35of82ValueDescriptionnormalNormalendpointgroupGroupedendpointst3T3ctsCiscoCTSorotherTIPcapableendpointscallStartMuteType:booleanTrueifthisendpointisbeingsentblackvideoduringcallsetup.
masterType:booleanValueDescriptiontrueThisendpointisconferencemasterfalse(defaultifomitted)ThisendpointisnottheconferencemastercallTypeType:stringValueDescriptionaudioAnaudioonlyparticipantvideoAvideoparticipantcallProtocolType:stringValueDescriptionsipThiscallusestheSIPprotocol.
h323ThiscallusestheH.
323protocol.
Conditional:enumerateIDType:integerEnumeratecallsmayreturnmanyresultssoallofthemwillacceptthisparameterandmayincludethisparameterintheresponse.
APIreferenceCiscoTelePresenceServerAPI2.
3Page36of82IftheresponseincludesanenumerateID,theapplicationshouldpasstheIDtothesubsequentenumeratecalltoretrievethenextsetofresults.
IftheresponsedoesnotincludeanenumerateID,therearenomoreresultsintheenumeration.
IftheapplicationomitstheenumerateID,thetargetdevicewillstartanewenumerationandreturnthefirstsetofresults.
Onlyreturnedifthereismoredatatoreturnthancanbecontainedinoneresponse.
disconnectReasonType:stringThereasonwhytheendpointdisconnected.
ValueDescriptionunspecifiedUnspecifiederrorlocalTeardownRequestedbyadministratornoAnswerNoanswerrejectedCallrejectedbusyBusygatekeeperErrorGatekeepererrorremoteTeardownLeftconferencetimeoutCalltimedoutprotocolErrorProtocolerrorunreachableEndpointisunreachablenetworkErrorNetworkerrorcapabilityNegotiationErrorCapabilitynegotiationerrordnsFailureDNSfailureOnlyreturnedfordisconnectedparticipants.
rxPreviewURLType:stringTheURLtoretrieveajpegsnapshotofvideoreceivedfromthisparticipant.
Onlyreturnedforactiveparticipants.
txPreviewURLType:stringTheURLtoretrieveajpegsnapshotofvideosenttothisparticipant.
Onlyreturnedforactiveparticipants.
callDurationAPIreferenceCiscoTelePresenceServerAPI2.
3Page37of82Type:integerThedurationofthecallinseconds.
Onlyreturnedforactiveparticipants.
callDirectionType:stringThisparameterisnotpresentifcallStateis0(notconnected).
ValueDescriptionincomingTheparticipantcalledintotheTelePresenceServeroutgoingTheTelePresenceServercalledouttotheparticipantOnlyreturnedforactiveparticipants.
callBandwidthType:integerCallbandwidthinkbps.
Onlyreturnedforactiveparticipants.
micMuteType:booleanTrueiffarendmicrophoneismuted.
recordingDeviceType:booleanValueDescriptiontrueTheendpointistreatedasarecordingdevice;itdoesnotfeatureinthelayoutandotherparticipantsaremadeawareofitspresencebyareddotasappropriate.
false(defaultifomitted)Theendpointisanormalendpoint.
Onlyreturnedforactiveparticipants.
txAudioMuteType:booleanDefineswhethertheTelePresenceServermutestheaudiosignaltransmittedtothisendpoint.
Onlyreturnedforactiveparticipants.
rxAudioMuteType:booleanAPIreferenceCiscoTelePresenceServerAPI2.
3Page38of82DefineswhethertheTelePresenceServermutestheaudiosignalreceivedfromthisendpoint.
Onlyreturnedforactiveparticipants.
txVideoMuteType:booleanDefineswhethertheTelePresenceServermutesthevideosignaltransmittedtothisendpoint.
Onlyreturnedforactiveparticipants.
rxVideoMuteType:booleanDefineswhethertheTelePresenceServermutesthevideosignalreceivedfromthisendpoint.
Onlyreturnedforactiveparticipants.
isImportantType:booleanDefineswhethertheparticipantisimportant(i.
e.
theparticipant'stransmittedvideoisgivenpreferenceoverotherswhencomposingvideo).
ValueDescriptiontrueTheparticipantisimportantfalse(Defaultifomitted)Theparticipant'svideoisnotgivenpreferenceoverotherthatoftheotherparticipantsOnlyreturnedforactiveparticipants.
conference.
uninviteStatus:activeRemovesparticipantsfromthespecifiedconference.
Thiscallrequiresoneconferenceidentificationparameterandoneparticipantlistparameter.
Thecallreturnsafaultifitcannotfindaspecifiedparticipant,eveniftheTelePresenceServerhassuccessfullyuninvitedtheotherspecifiedparticipants.
Accepts:Required:Toidentifytheconference,useconferenceGUIDinsteadofconferenceID,notboth.
conferenceGUIDType:stringGloballyuniqueidentifieroftheconference.
APIreferenceCiscoTelePresenceServerAPI2.
3Page39of82conferenceIDType:integerDeprecated.
UseconferenceGUIDinstead.
Uniqueconferenceidentifier.
Optional:Toidentifyparticipantstouninvite,useonlyoneofthefollowingoptionalparameters.
participantListGUIDType:stringCommaseparatedlistofparticipantGUIDsthatidentifieswhichparticipantstoremovefromthisconference.
Forexample,C8200C3F-49CE-4763-98E0-790B4F038995,B1101410-6BB8-487E-9D6F-91E810E80651.
participantListType:stringAcommaseparatedlistofparticipantaddresses.
ValueDescriptionExamplestring10.
2.
171.
232,10.
47.
2.
246,h323:numericID@domain.
comparticipantListIDType:stringDeprecated.
UseparticipantListGUIDinstead.
CommaseparatedlistofparticipantIDsthatidentifieswhichparticipantstoremovefromtheconference.
Forexample;1024,1056.
device.
queryStatus:activeReturnshighlevelstatusinformationaboutthedevice.
Itdoesnotacceptparametersotherthantheauthenticationstrings.
Returns:currentTimeType:dateTime.
iso8601Thesystem'scurrenttime(UTC).
restartTimeAPIreferenceCiscoTelePresenceServerAPI2.
3Page40of82Type:dateTime.
iso8601Thedateandtimewhenthesystemwaslastrestarted.
uptimeType:integerThenumberofsecondssincethelastrestart.
serialType:stringTheserialnumberofthedevice.
apiVersionType:stringTheversionnumberoftheAPIimplementedbythisdevice.
activatedFeaturesType:arrayEachmembercontainsastringnamedfeaturecontainingashortdescriptionofthatfeature,forexample,Encryption.
shutdownStatusType:stringDisplaysoneofthefollowing:notShutdown,shutdownInProgress,shutdownorerror.
device.
network.
queryStatus:activeQueriesthedeviceforitsnetworkinformation.
Thecalltakesnoparametersandreturnsthefollowingdatastructures.
Someofthedatalistedbelowwillbeomittediftheinterfaceisnotenabledorconfigured.
Thequeryreturnsemptystringsordashesforaddressesthatarenotconfigured.
Returns:dnsType:structAnarraywhosemembersrepresentthedevice'sDNSparameters.
portAType:structAstructurethatcontainsconfigurationandstatusinformationforEthernetportAonthedevice.
APIreferenceCiscoTelePresenceServerAPI2.
3Page41of82dnsarrayhostNameType:stringThehostnameofquerieddevice.
nameServerType:stringTheIPaddressofthenameserver,indottedquadformat(IPv4)orCIDRformat(IPv6).
nameServerSecondaryType:stringTheIPaddressofthesecondarynameserver,indottedquadformat(IPv4)orCIDRformat(IPv6).
domainNameType:stringThedomainname(DNSsuffix).
PortarraysstructureenabledType:booleanValueDescriptiontrueThesubjectofthiscallorresponseisenabled.
falseThesubjectofthiscallorresponseisnotenabled.
ipv4EnabledType:booleantrueifIPv4interfaceisenabled.
ipv6EnabledType:booleantrueifIPv6interfaceisenabled.
linkStatusType:booleanValueDescriptiontrueTheethernetconnectiontothisportisactive.
APIreferenceCiscoTelePresenceServerAPI2.
3Page42of82ValueDescriptionfalseTheethernetconnectiontothisportisnotactive.
speedType:integerSpeedoftheconnectiononthisEthernetinterface.
Oneof10,100or1000,inMbps.
fullDuplexType:booleanValueDescriptiontrueTheportcansupportafull-duplexconnection.
falseTheportcansupportahalf-duplexconnection.
macAddressType:stringTheMACaddressofthisinterface.
A12characterstringofhexdigitswithnoseparators.
packetsSentType:integerThenumberofpacketssentfromthisEthernetport.
Notethatthisvalueisa32-bitsignedinteger,andthusmaywrap.
packetsReceivedType:integerThenumberofpacketsreceivedonthisEthernetport.
Notethatthisvalueisa32-bitsignedinteger,andthusmaywrap.
multicastPacketsSentType:integerNumberofmulticastpacketssentfromthisEthernetinterface.
Notethatthisvalueisa32-bitsignedinteger,andthusmaywrap.
multicastPacketsReceivedType:integerNumberofmulticastpacketsreceivedonthisEthernetinterface.
Notethatthisvalueisa32-bitsignedinteger,andthusmaywrap.
bytesSentType:integerAPIreferenceCiscoTelePresenceServerAPI2.
3Page43of82Thenumberofbytessentbythedevice.
Notethatthisvalueisa32-bitsignedinteger,andthusmaywrap.
bytesReceivedType:integerThenumberofbytesreceivedbythedevice.
Notethatthisvalueisa32-bitsignedinteger,andthusmaywrap.
queueDropsType:integerNumberofpacketsdroppedfromthequeueonthisnetworkinterface.
Notethatthisvalueisa32-bitsignedinteger,andthusmaywrap.
collisionsType:integerCountofthenetworkcollisionsrecordedbythedevice.
Notethatthisvalueisa32-bitsignedinteger,andthusmaywrap.
transmitErrorsType:integerThecountoftransmissionerrorsonthisEthernetinterface.
Notethatthisvalueisa32-bitsignedinteger,andthusmaywrap.
receiveErrorsType:integerThecountofreceiveerrorsonthisinterface.
Notethatthisvalueisa32-bitsignedinteger,andthusmaywrap.
bytesSent64Type:string64bitversionsofthebytesSentstatistic,usingastringratherthananinteger.
bytesReceived64Type:string64bitversionsofthebytesReceivedstatistic,usingastringratherthananinteger.
Conditional:Thefollowingparametersarereturnedonlyiftheinterfaceisenabledandconfigured.
dhcpv4Type:booleanAPIreferenceCiscoTelePresenceServerAPI2.
3Page44of82ValueDescriptiontrueThedevice'sIPaddressisallocatedbyDHCPfalseThedevice'sIPaddressismanuallyconfiguredipv4AddressType:stringIPv4IPaddressindotted-quadformat.
ipv4SubnetMaskType:stringTheIPv4subnetmaskindottedquadformat.
defaultipv4GatewayType:stringThedevice'sIPv4defaultgatewayindottedquadformat.
ipv6ConfType:stringIndicateshowtheIPv6addressisassigned.
ValueDescriptionautomaticThisinterface'sIPv6addressisconfiguredautomatically(bySLAAC/DHCPv6)manualThisinterface'sIPv6addressisconfiguredmanuallyipv6AddressType:string(63)TheIPv6addressinCIDRformat.
ipv6PrefixLengthType:integerThelengthoftheIPv6addressprefix.
defaultIpv6GatewayType:string(63)TheaddressoftheIPv6defaultgatewayinCIDRformat.
linkLocalIpv6AddressType:string(63)APIreferenceCiscoTelePresenceServerAPI2.
3Page45of82ThelinklocalIPv6addressinCIDRformat.
linkLocalIpv6PrefixLengthType:integerLengthofthelinklocalIPv6addressprefix.
device.
health.
queryStatus:activeReturnsthecurrentstatusofthedevice,suchashealthmonitorsandCPUload.
Returns:cpuLoadType:integerTheCPUloadasapercentageofthemaximum.
fanStatusType:stringValueDescriptionokThefaniscurrentlyfunctioningproperly.
outOfSpecThefaniscurrentlynotfunctioningproperly.
fanStatusisonlyreturnedon7010devices,not8710s.
fanStatusWorstType:stringValueDescriptionokThefanhasbeenfunctioningproperlysincethedevicewasbooted.
outOfSpecThefanhasnotbeenfunctioningproperlysincethedevicewasbooted.
fanStatusWorstisonlyreturnedon7010devices,not8710s.
temperatureStatusType:stringValueDescriptionokThetemperatureiscurrentlywithinthenormaloperatingrange.
outOfSpecThetemperatureiscurrentlyoutsidethenormaloperatingrange.
APIreferenceCiscoTelePresenceServerAPI2.
3Page46of82ValueDescriptioncriticalThetemperatureistoohighandthedevicewillshutdownifthisconditionpersists.
temperatureStatusWorstType:stringTheworsttemperaturestatusrecordedonthisdevicesinceitbooted.
ValueDescriptionokThetemperaturehasbeenwithinthenormaloperatingrangesincethedevicewasbooted.
outOfSpecThetemperaturehasbeenoutsidethenormaloperatingrangeatleastoncesincethedevicewasbooted.
criticalAtsomepointsincethelastbootthetemperaturewastoohigh.
Thedevicewillshutdownifthisconditionpersists.
rtcBatteryStatusType:stringThecurrentstatusoftheRTCbattery(RealTimeClock).
ValueDescriptionokThebatteryisoperatingwithinthenormalrange.
outOfSpecThebatteryisoperatingoutsideofthenormalrange,andmayrequireservice.
rtcBatteryStatusWorstType:stringTheworstrecordedstatusoftheRTCbattery.
ValueDescriptionokThebatteryhasbeenoperatinginsidethenormalrangesincethedevicewasbooted.
outOfSpecThebatteryhasoperatedoutsideofthenormalrangeatsometimesincethedevicewasbooted.
voltagesStatusType:stringAPIreferenceCiscoTelePresenceServerAPI2.
3Page47of82ValueDescriptionokThevoltageiscurrentlywithinthenormalrangeoutOfSpecThevoltageiscurrentlyoutsidethenormalrangevoltagesStatusWorstType:stringValueDescriptionokThevoltagehasbeenwithinthenormalrangesincethedevicelastbooted.
outOfSpecThevoltagehasbeenoutsidethenormalrangeatsometimesincethedevicelastbootedoperationalStatusType:stringValueDescriptionactiveTheTelePresenceServerisacive.
shuttingDownThedeviceisshuttingdown.
shutDownThedevicehasshutdown.
unknownTheoperationalstatusofthedeviceisunknown.
device.
restartlog.
queryStatus:activeReturnstherestartlog-alsoknownasthesystemlogonthewebinterface.
Returns:logType:arrayEachmemberofthearraycontainsloginformation(calledsystemlogintheuserinterface).
logarraymemberstimeType:dateTime.
iso8601Thetimewhenthedevicerestarted.
APIreferenceCiscoTelePresenceServerAPI2.
3Page48of82ValueDescription20110119T13:52:42yyyymmddThh:mm:ssreasonType:stringValueDescriptionUserrequestedshutdownThedevicerestartednormallyafterauserinitiatedashutdown.
UserrequestedrebootfromwebinterfaceThedevicerestarteditselfbecauseauserinitiatedarebootviathewebinterface.
UserrequestedupgradeThedevicerestarteditselfbecauseauserinitiatedanupgrade.
UserrequestedrebootfromconsoleThedevicerestarteditselfbecauseauserinitiatedarebootviatheconsole.
UserrequestedrebootfromAPIThedevicerestarteditselfbecauseauserinitiatedarebootviatheAPI.
UserrequestedrebootfromFTPThedevicerestarteditselfbecauseauserinitiatedarebootviaFTP.
UserrequestedshutdownfromsupervisorThedevicerestartednormallyafterauserinitiatedashutdownfromthesupervisor.
UserrequestedrebootfromsupervisorThedevicerestarteditselfbecauseauserinitiatedarebootviathesupervisor.
UserresetconfigurationThedevicerestarteditselfbecauseauserresettheconfiguration.
ColdbootThedevicerestarteditselfbecauseauserinitiatedacoldboot.
unknownThesoftwareisunawarewhythedevicerestarted.
device.
restartStatus:activeRestartsthedevice,orshutsitdownwithoutarestart.
Accepts:Optional:shutdownOnlyType:booleanValueDescriptiontrueThedevicewillshutdownwhenitreceivesthisrequestandwillnotrestart.
falseThisisthedefaultvalue.
APIreferenceCiscoTelePresenceServerAPI2.
3Page49of82participant.
diagnosticsStatus:activeThecallspecifieswhichparticipant'sdiagnosticstoretrieveandalsoalisteninginterfaceforthereturnedinformation.
ThereasonforprovidingreceiverURIisbecausethecallisasynchronous;youshouldreceivean"Operationsuccessful"resultslightlybeforethedatareturns(anXML-RPCmethodCallwithmethodNameparticipantDiagnosticsResponse)onthelisteninginterface.
ThismethodmayreturnFault203:'toomanyasynchronousrequeststhismeansthattheTelePresenceServeriscurrentlyprocessingthemaxmimumpossiblenumberofdiagnosticsrequestsandanotherrequestcannotbeprocessedatthistime.
Therequestshouldberetriedlater.
ThereturnedinformationcontainsarrayscomprisingthedifferenttypesofdatastreamsbetweenthisparticipantandthehostingTelePresenceServer.
Eacharraymemberrepresentsasinglestream.
ExampleXML-RPCresponsetoparticipant.
diagnosticsIftherearenostreamsofaparticulartype,thecorrespondingarrayisreturnedempty.
Accepts:Required:participantGUIDType:stringTheGUIDofthisparticipant,assignedbytheTelePresenceServer.
receiverURIType:string(upto255characters)Fully-qualifiedURIthatidentifiesthelisteningapplication'sXML-RPCinterface(protocol,address,andport),forexample,http://tms1:8080/RPC2.
Youcanusehttporhttpsand,ifnoportnumberisspecified,thedevicewillusetheprotocoldefaults(80and443respectively).
Optional:sourceIdentifierType:string(upto255characters)Theoriginatingdeviceusesthisparametertoidentifyitselftothelisteningreceiver/s.
Iftheparameterisnotexplicitlyset,thedeviceidentifiesitselfwiththeMACaddressofitsEthernetportAinterface.
Returns:participantGUIDType:stringTheGUIDofthisparticipant,assignedbytheTelePresenceServer.
APIreferenceCiscoTelePresenceServerAPI2.
3Page50of82sourceIdentifierType:string(upto255characters)Theoriginatingdeviceusesthisparametertoidentifyitselftothelisteningreceiver/s.
Iftheparameterisnotexplicitlyset,thedeviceidentifiesitselfwiththeMACaddressofitsEthernetportAinterface.
audioRxType:arrayAnarrayofstructs,eachofwhichrepresentsanaudiostreamreceivedfromtheparticipant'sendpoint.
audioTxType:arrayAnarrayofstructs,eachofwhichrepresentsanaudiostreamtransmittedtotheparticipant'sendpoint.
auxiliaryAudioRxType:arrayAnarrayofstructs,eachofwhichrepresentsanauxiliaryaudiostreamreceivedfromtheparticipant'sendpoint.
auxiliaryAudioTxType:arrayAnarrayofstructs,eachofwhichrepresentsanauxiliaryaudiostreamtransmittedtotheparticipant'sendpoint.
videoRxType:arrayAnarrayofstructs,eachofwhichrepresentsavideostreamreceivedfromtheparticipant'sendpoint.
videoTxType:arrayAnarrayofstructs,eachofwhichrepresentsavideostreamtransmittedtotheparticipant'sendpoint.
contentVideoRxType:arrayAnarrayofstructs,eachofwhichrepresentsacontentvideostreamreceivedfromtheparticipant'sendpoint.
contentVideoTxType:arrayAPIreferenceCiscoTelePresenceServerAPI2.
3Page51of82Anarrayofstructs,eachofwhichrepresentsacontentvideostreamtransmittedtotheparticipant'sendpoint.
Contentsofdiagnosticsarrays:Eachoftheabovearraysmaycontainszeroormorestreamstructs.
Eachstreamstructwillcontainrelevantparameter/valuepairsfromthefollowinglists:Allstreams:codecType:stringThecodecinuse,orotherforundefinedcodecs.
encryptedType:booleanTrueifthestreamdataisencrypted.
mutedType:booleanTrueifthestreamismuted.
channelBitRateType:integerBitrateofthechannelinbitspersecond(bps).
Conditional,dependingonthetypeanddirectionofthestream:packetsSentType:integerCountofpacketssentinthisstream.
packetsReceivedType:integerCountofpacketsreceivedinthisstream.
packetErrorsType:integerCountofpacketswitherrorsinthisstream.
packetsMissingType:integerCountofpacketsmissingfromthisstream.
APIreferenceCiscoTelePresenceServerAPI2.
3Page52of82framesReceivedType:integerCountofframesreceivedinthisstream.
frameErrorsType:integerCountofframeswitherrorsinthisstream.
jitterType:integerCurrentjitterinthisstream,measuredinmilliseconds(ms).
energyType:integerThelevelofthesignal,suppliedindecibels(dB).
configuredBitRateType:integerTheconfiguredbitrateofthisstream,inbitspersecond(bps).
configuredBitRateReasonType:stringValueDescriptionaggregateBandwidthTheTelePresenceServerhaslimitedthebitratesothatmultiplestreamscanbesentwithoutexceedingagivenlimitonoverallbandwidth.
flowControlThefarendhasrequestedthattheTelePresenceServersendsvideoatalowerbitrate.
notLimitedTheconfiguredbitrateisnotlimitedbyflowControloraggregateBandwidth.
expectedBitRateType:integerTheexpectedbitrateofthisstream,inbitspersecond(bps).
expectedBitRateReasonType:stringAPIreferenceCiscoTelePresenceServerAPI2.
3Page53of82ValueDescriptionviewedSizeTheTelePresenceServerrequestedareductioninthebitrateofthevideostreambecausethevideostreamfromthatendpointisnotbeingdisplayedatfullsize.
errorPacketsTheTelePresenceServerrequestedareductioninthebitrateofthevideostreambecausethereareerrorsinthevideostream.
notLimitedTheTelePresenceServerhasnotrequestedareductioninthebitrateofthevideostream.
actualBitRateType:integerThemeasuredbitrateofthisstream,inbitspersecond(bps).
frameRateType:integerTheframerateofthevideostream,inframespersecond(fps).
fastUpdateRequestsSentType:integerThecountoffastupdaterequestssentinthisstream.
fastUpdateRequestsReceivedType:integerThecountoffastupdaterequestsreceivedinthisstream.
participant.
enumerateStatus:activeReturnsanarrayoftheparticipantswhoareactiveonthequeriedTelePresenceServer.
Endpointsthatareeitherconnectingorinactiveatthetimeoftheenumerationarenotincludedintheresponse.
Accepts:Optional:enumerateIDType:integerEnumeratecallsmayreturnmanyresultssoallofthemwillacceptthisparameterandmayincludethisparameterintheresponse.
APIreferenceCiscoTelePresenceServerAPI2.
3Page54of82IftheresponseincludesanenumerateID,theapplicationshouldpasstheIDtothesubsequentenumeratecalltoretrievethenextsetofresults.
IftheresponsedoesnotincludeanenumerateID,therearenomoreresultsintheenumeration.
IftheapplicationomitstheenumerateID,thetargetdevicewillstartanewenumerationandreturnthefirstsetofresults.
Returns:Iftherearenoparticipantstoenumerate,thentheparticipant.
enumeratecalldoesnotreturntheparticipantsarray.
Conditional:participantsType:arrayAnarrayofstructuresthatrepresentparticipants.
enumerateIDType:integerEnumeratecallsmayreturnmanyresultssoallofthemwillacceptthisparameterandmayincludethisparameterintheresponse.
IftheresponseincludesanenumerateID,theapplicationshouldpasstheIDtothesubsequentenumeratecalltoretrievethenextsetofresults.
IftheresponsedoesnotincludeanenumerateID,therearenomoreresultsintheenumeration.
IftheapplicationomitstheenumerateID,thetargetdevicewillstartanewenumerationandreturnthefirstsetofresults.
participantsarrayparticipantGUIDType:stringTheGUIDofthisparticipant,assignedbytheTelePresenceServer.
participantIDType:integerDeprecated.
UseparticipantGUIDinstead.
TheuniqueIDofthisparticipant,assignedbytheTelePresenceServer.
conferenceGUIDType:stringGloballyuniqueidentifieroftheconference.
conferenceIDAPIreferenceCiscoTelePresenceServerAPI2.
3Page55of82Type:integerDeprecated.
UseconferenceGUIDinstead.
Uniqueconferenceidentifier.
addressType:stringTheaddressoftheitem,e.
g.
endpointorgateway;maybehostname,IPaddressorE.
164number.
endpointCategoryType:stringValueDescriptionnormalNormalendpointgroupGroupedendpointst3T3ctsCiscoCTSorotherTIPcapableendpointscallProtocolType:stringValueDescriptionsipThiscallusestheSIPprotocol.
h323ThiscallusestheH.
323protocol.
callStateType:integerStateofthecallbetweentheTelePresenceServerandthisparticipant.
ValueDescription0Notconnected1Callingin(notyetinconference)2Calledinandparticipating3Callingout(notyetinconference)4Calledoutandparticipatingparticipant.
setStatus:activeAPIreferenceCiscoTelePresenceServerAPI2.
3Page56of82Changesthestateofthesuppliedparametersforthespecifiedparticipant.
Accepts:Required:Toidentifytheparticipant,useparticipantGUIDinsteadofparticipantID,notboth.
participantGUIDType:stringTheGUIDofthisparticipant,assignedbytheTelePresenceServer.
participantIDType:integerDeprecated.
UseparticipantGUIDinstead.
TheuniqueIDofthisparticipant,assignedbytheTelePresenceServer.
Optional:txAudioMuteType:booleanDefineswhethertheTelePresenceServermutestheaudiosignaltransmittedtothisendpoint.
rxAudioMuteType:booleanDefineswhethertheTelePresenceServermutestheaudiosignalreceivedfromthisendpoint.
txVideoMuteType:booleanDefineswhethertheTelePresenceServermutesthevideosignaltransmittedtothisendpoint.
rxVideoMuteType:booleanDefineswhethertheTelePresenceServermutesthevideosignalreceivedfromthisendpoint.
isImportantType:booleanDefineswhethertheparticipantisimportant(i.
e.
theparticipant'stransmittedvideoisgivenpreferenceoverotherswhencomposingvideo).
APIreferenceCiscoTelePresenceServerAPI2.
3Page57of82ValueDescriptiontrueTheparticipantisimportantfalse(Defaultifomitted)Theparticipant'svideoisnotgivenpreferenceoverotherthatoftheotherparticipantsparticipant.
tidylayoutStatus:activeTidiesupthecomposedvideolayoutsenttothespecifiedparticipant'sendpoint.
Accepts:Required:participantGUIDType:stringTheGUIDofthisparticipant,assignedbytheTelePresenceServer.
participantIDType:integerDeprecated.
UseparticipantGUIDinstead.
TheuniqueIDofthisparticipant,assignedbytheTelePresenceServer.
system.
infoStatus:activeReturnsthecurrentstatusofthequeriedsystem.
Returns:gateKeeperOKType:booleanTrueifthegatekeeperisconfiguredandtheTelePresenceServerisregistered.
makeCallsOKType:booleanTrueifthesystemhasenoughresourcestomakeatleastonecall.
tpsNumberOKType:integerAPIreferenceCiscoTelePresenceServerAPI2.
3Page58of82ThecountofconfiguredandactiveTelePresenceServers.
tpdVersionType:stringTheTelePresenceServersoftwareversionnumber.
tpdNameType:stringTheTelePresenceServersystemname.
tpdUptimeType:integerTheperiodoftime(inseconds)thathaspassedsincethesystembooted.
tpdSerialType:stringTheserialnumberoftheTelePresenceServer.
portsVideoTotalType:integerThetotalnumberofvideoports.
portsVideoFreeType:integerCountofthecurrentlyunusedvideoports.
portsAudioTotalType:integerThetotalnumberofaudioports.
portsAudioFreeType:integerCountofthecurrentlyunusedaudioports.
portsContentTotalType:integerThetotalnumberofcontentports.
portsContentFreeType:integerCountofthecurrentlyunusedcontentports.
APIreferenceCiscoTelePresenceServerAPI2.
3Page59of82maxConferenceSizeVideoType:integerThecountofunusedvideoportsontheleast-usedTelePresenceServercontrolledbythisunit.
Indicatesthemaximumnumberofvideoportsthatcouldcurrentlybeallocatedtoasingleconference.
maxConferenceSizeAudioType:integerThecountofunusedaudio-onlyportsontheleast-usedTelePresenceServercontrolledbythisunit.
Indicatesthemaximumnumberofaudio-onlyportsthatcouldcurrentlybeallocatedtoasingleconference.
maxConferenceSizeContentType:integerThecountofunusedcontentportsontheleast-usedTelePresenceServercontrolledbythisunit.
Indicatesthemaximumnumberofcontentportsthatcouldcurrentlybeallocatedtoasingleconference.
numControlledServersType:integerThenumberofTelePresenceServerscontrolledbythisunit(includingitself).
operationModeType:stringTheoperationmodeisstandalone(evenforclusteredunits).
licenseModeType:stringThelicensemodeiseitherHDorfullHD.
FeedbackreceiversCiscoTelePresenceServerAPI2.
3Page60of82FeedbackreceiversTheAPIallowsyoutoregisteryourapplicationasafeedbackreceiver.
Thismeansthattheapplicationdoesn'thavetoconstantlypollthedeviceifitwantstomonitoractivity.
Thedevicepublisheseventswhentheyoccur.
Ifthedeviceknowsthatyourapplicationislisteningfortheseevents,itwillsendXML-RPCmessagestoyourapplication'sinterfacewhentheeventsoccur.
nUsefeedbackReceiver.
configuretoregisterareceivertolistenforoneormorefeedbackevents.
nUsefeedbackReceiver.
querytoreturnalistofreceiversthatareconfiguredonthedevice.
nUsefeedbackReceiver.
reconfiguretochangetheconfigurationofanexistingfeedbackreceiver.
nUsefeedbackReceiver.
removetoremoveanexistingfeedbackreceiver.
nUsefeedbackReceiver.
statustoviewalistoftheeventsthatafeedbackreceiverissubscribedto.
Afterregisteringasafeedbackreceiver,theapplicationwillreceivefeedbackmessagesonthespecifiedinterface.
feedbackReceiver.
queryStatus:activeThiscallasksthedeviceforalistofallthefeedbackreceiversthathavepreviouslybeenconfigured.
Itdoesnotacceptparametersotherthantheauthenticationstrings.
Returns:Iftherearenofeedbackreceiverstoenumerate,thenthefeedbackReceiver.
queryreturnsanemptyreceiversarray.
receiversType:arrayAnarrayoffeedbackreceivers,withmemberscorrespondingtotheentriesinthereceiverstableonthedevice'swebinterface.
receiversarraymembersEachreceiverintheresponsecontainsthefollowingparameters:receiverURIType:string(upto255characters)Fully-qualifiedURIthatidentifiesthelisteningapplication'sXML-RPCinterface(protocol,address,andport),forexample,http://tms1:8080/RPC2.
Youcanusehttporhttpsand,ifnoportnumberisspecified,thedevicewillusetheprotocoldefaults(80and443respectively).
sourceIdentifierFeedbackreceiversCiscoTelePresenceServerAPI2.
3Page61of82Type:string(upto255characters)Theoriginatingdeviceusesthisparametertoidentifyitselftothelisteningreceiver/s.
Iftheparameterisnotexplicitlyset,thedeviceidentifiesitselfwiththeMACaddressofitsEthernetportAinterface.
indexType:integerAnumberthatidentifiesthepositionoftheitemincontextwithsimilaritems.
TheindexdescribesthepositionofthisfeedbackreceiverintheTelePresenceServer'stableoffeedbackreceivers.
Itisanumberbetween1and20(inclusive).
feedbackReceiver.
configureStatus:activeThiscallconfiguresthedevicetosendfeedbackaboutthespecifiedsubscribedEventstothespecifiedreceiverURI.
Accepts:Required:receiverURIType:string(upto255characters)Fully-qualifiedURIthatidentifiesthelisteningapplication'sXML-RPCinterface(protocol,address,andport),forexample,http://tms1:8080/RPC2.
Youcanusehttporhttpsand,ifnoportnumberisspecified,thedevicewillusetheprotocoldefaults(80and443respectively).
Optional:sourceIdentifierType:string(upto255characters)Theoriginatingdeviceusesthisparametertoidentifyitselftothelisteningreceiver/s.
Iftheparameterisnotexplicitlyset,thedeviceidentifiesitselfwiththeMACaddressofitsEthernetportAinterface.
receiverIndexType:integerThepositionofthisfeedbackreceiverinthedevice'stableoffeedbackreceivers.
ValueDescription-1Thefeedbackreceiverwilluseanyavailableposition.
1Thefirstpositioninthetable(thisvalueisassumedifyoudon'tsupplyreceiverIndex-overwritinganyexistingentryinposition1)20The20th(maximumallowed)positionFeedbackreceiversCiscoTelePresenceServerAPI2.
3Page62of82WerecommendthatyousetreceiverIndexto-1inthiscall.
ThisensuresthattheTelePresenceServerallocatesanavailableslotandthatyoudon'tinadvertentlyoverwriteanexistingfeedbackreceiverinslot1.
subscribedEventsType:arrayAnarrayofstrings,eachofwhichisthenameofanotificationevent.
Thearraydefinestheeventstowhichthereceiversubscribes.
Youmayspecifyanyorallofthefollowing:ncdrAddednconferenceStartednconferenceFinishednconferenceActivenconferenceInactivenconfigureAckndeviceStatusChangednparticipantJoinednparticipantLeftnparticipantConnectednparticipantDisconnectednreceiverModifiednreceiverDeletednrestartIfthisarrayisabsent,thereceiversubscribestoallnotificationsbydefault.
Returns:ThecallreturnstheallocatedreceiverIndex.
receiverIndexType:integerThepositionofthisfeedbackreceiverinthedevice'stableoffeedbackreceivers.
feedbackReceiver.
reconfigureStatus:activeThiscallreconfiguresanexistingfeedbackreceiver.
Thiscallonlyreconfiguresthereceiverparametersthatyouspecify;theTelePresenceServerretainstheoriginalvaluesforanyparametersthatyouomit.
FeedbackreceiversCiscoTelePresenceServerAPI2.
3Page63of82Accepts:Required:receiverIndexType:integerThepositionofthisfeedbackreceiverinthedevice'stableoffeedbackreceivers.
ThecallreturnsafaultifthereisnofeedbackreceiveratthespecifiedreceiverIndex.
Optional:receiverURIType:string(upto255characters)Fully-qualifiedURIthatidentifiesthelisteningapplication'sXML-RPCinterface(protocol,address,andport),forexample,http://tms1:8080/RPC2.
Youcanusehttporhttpsand,ifnoportnumberisspecified,thedevicewillusetheprotocoldefaults(80and443respectively).
ThecallreturnsafaultifyousupplyanemptyreceiverURI.
However,ifyouomittheparameteraltogether,theoriginalvaluepersists.
sourceIdentifierType:string(upto255characters)Theoriginatingdeviceusesthisparametertoidentifyitselftothelisteningreceiver/s.
Iftheparameterisnotexplicitlyset,thedeviceidentifiesitselfwiththeMACaddressofitsEthernetportAinterface.
subscribedEventsType:arrayAnarrayofstrings,eachofwhichisthenameofanotificationevent.
Thearraydefinestheeventstowhichthereceiversubscribes.
Youmayspecifyanyorallofthefollowing:ncdrAddednconferenceStartednconferenceFinishednconferenceActivenconferenceInactivenconfigureAckndeviceStatusChangednparticipantJoinednparticipantLeftnparticipantConnectednparticipantDisconnectedFeedbackreceiversCiscoTelePresenceServerAPI2.
3Page64of82nreceiverModifiednreceiverDeletednrestartIfthisarrayisabsent,thereceiver'sexistingsubscriptionswillnotbechangedfromthevaluescreatedbytheoriginalfeedbackReceiver.
configurecall.
feedbackReceiver.
removeStatus:activeRemovesthespecifiedfeedbackreceiver.
Accepts:Required:receiverIndexType:integerThepositionofthisfeedbackreceiverinthedevice'stableoffeedbackreceivers.
ThecallreturnsafaultifthereisnofeedbackreceiveratthespecifiedreceiverIndex.
feedbackReceiver.
statusStatus:activeThiscallasksthedeviceforalistofalltheeventsthatafeedbackreceiverissubscribedto.
Accepts:Required:receiverIndexType:integerThepositionofthisfeedbackreceiverinthedevice'stableoffeedbackreceivers.
ThecallreturnsafaultifthereisnofeedbackreceiveratthespecifiedreceiverIndex.
Returns:Iftherearenoeventssubscribedtobythefeedbackreceiverstoenumerate,thenthefeedbackReceiver.
statusreturnsanemptyreceiversarray.
receiverIndexType:integerThepositionofthisfeedbackreceiverinthedevice'stableoffeedbackreceivers.
FeedbackreceiversCiscoTelePresenceServerAPI2.
3Page65of82receiverURIType:string(upto255characters)Fully-qualifiedURIthatidentifiesthelisteningapplication'sXML-RPCinterface(protocol,address,andport),forexample,http://tms1:8080/RPC2.
Youcanusehttporhttpsand,ifnoportnumberisspecified,thedevicewillusetheprotocoldefaults(80and443respectively).
sourceIdentifierType:string(upto255characters)Theoriginatingdeviceusesthisparametertoidentifyitselftothelisteningreceiver/s.
Iftheparameterisnotexplicitlyset,thedeviceidentifiesitselfwiththeMACaddressofitsEthernetportAinterface.
subscribedEventsType:arrayAnarrayofstrings,eachofwhichisthenameofanotificationevent.
Thearraydefinestheeventstowhichthereceiversubscribes.
Youmayspecifyanyorallofthefollowing:ncdrAddednconferenceStartednconferenceFinishednconferenceActivenconferenceInactivenconfigureAckndeviceStatusChangednparticipantJoinednparticipantLeftnparticipantConnectednparticipantDisconnectednreceiverModifiednreceiverDeletednrestartFeedbackmessagesThefeedbackmessagesfollowtheformatusedbythedeviceforXML-RPCresponses.
Themessagescontaintwoparameters:nsourceIdentifierisastringthatidentifiesthedevice,whichmayhavebeensetbyfeedbackReceiver.
configureorotherwisewillbethedevice'sMACaddress.
neventsisanarrayofstringsthatcontainthenamesofthefeedbackeventsthathaveoccurred.
ExamplefeedbackmessageFeedbackreceiversCiscoTelePresenceServerAPI2.
3Page66of82eventNotificationsourceIdentifier000D7C000C66eventsrestartFeedbackeventsThefollowingtableliststhefeedbackeventsthattheTelePresenceServercanpublish.
EventDescriptionrestartThesourcepublishesthiseventwhenitstartsupconfigureAckThesourcepublishesthiseventtoacknowledgethatanapplicationhassuccessfullyconfiguredafeedbackreceivercdrAddedOneormorenewCallDetailRecordshavebeenloggedconferenceStartedOneormoreconferenceshavebeencreatedconferenceFinishedOneormoreconferenceshavebeendeletedconferenceActiveOneormoreconferenceshavebecomeactive(firstparticipantjoined)conferenceInactiveOneormoreconferenceshavebecomeinactive(lastparticipantleft)participantJoinedOneormoreparticipantshavejoinedaconferenceparticipantLeftOneormoreparticipantshaveleftaconferenceparticipantConnectedOneormoreparticipantshaveconnectedtotheTelePresenceServerFeedbackreceiversCiscoTelePresenceServerAPI2.
3Page67of82EventDescriptionparticipantDisconnectedOneormoreparticipantsdisconnectedfromtheTelePresenceServerreceiverModifiedThefeedbackreceiverreceivingthiseventhasbeenmodified.
Cannotbeunsubscribedfromordisabled.
receiverDeletedThefeedbackreceiverreceivingthiseventhasbeenstoppedanditsconfigurationdeletedortheURIofthefeedbackreceiverhasbeenchanged,inwhichcasethiseventissenttothepreviousURI.
Cannotbeunsubscribedfromordisabled.
deviceStatusChangedGeneratedwhentheTelePresenceServerisshutdownorafeaturekeyisaddedorremoved.
Shouldresultinadevice.
queryrequestbeingmade.
APIoverviewEncodingYourapplicationcanencodemessagesasASCIItextorasUTF-8Unicode.
Ifyoudonotspecifytheencoding,theAPIassumesASCIIencoding.
Youcanspecifytheencodinginanumberofways:SpecifyencodingwithHTTPheadersTherearetwowaysofspecifyingUTF-8intheHTTPheaders:nUsetheAccept-Charset:utf-8headernModifytheContent-TypeheadertoreadContent-Type:text/xml;charset=utf-8SpecifyencodingwithXMLheaderThetagisrequiredatthetopofeachXMLfile.
TheAPIwillacceptanencodingattributeforthistag;thatis,.
AuthenticationNote:Authenticationinformationissentusingplaintextandshouldonlybesentoveratrustednetwork.
Thecontrollingapplicationmustauthenticateitselfonthedeviceasauserwithadministrativeprivileges.
Also,becausetheinterfaceisstateless,everycallmustcontainauthenticationparameters:authenticationUserType:stringNameofauserwithsufficientprivilegefortheoperationbeingperformed.
Thenameiscasesensitive.
authenticationPasswordType:stringFeedbackreceiversCiscoTelePresenceServerAPI2.
3Page68of82ThepasswordthatcorrespondswiththegivenauthenticationUser.
TheAPIignoresthisparameteriftheuserhasnopassword.
Thisbehaviordiffersfromthewebinterface,whereablankpasswordmustbeblank.
MessageflowTheapplicationinitiatesthecommunicationandsendsacorrectlyformattedXML-RPCcommandtothedevice.
Theexamplecommandbelowis:createconference:'APIConference'withnumericID:'971771'andPIN:'123'Examplecommandconference.
createauthenticationUseradminauthenticationPasswordconferenceNameAPIConferencenumericID971771PIN123FeedbackreceiversCiscoTelePresenceServerAPI2.
3Page69of82Assumingthecommandwaswellformed,andthatthedeviceisresponsive,thedevicewillrespondinoneoftheseways:nWithanXMLmethodResponsemessagethatmayormaynotcontaindata,dependingonthecommand.
nWithanXMLmethodResponsethatincludesonlyafaultcodemessage.
ExamplesuccessconferenceID10000conferenceGUID62f46be0-c6a3-11e1-9800-000d7c10cc70ExamplefaultcodefaultCode13FeedbackreceiversCiscoTelePresenceServerAPI2.
3Page70of82faultStringinvalidPINRelatedinformationCiscoTelePresenceServerAPI2.
3Page71of82Relatedinformationsystem.
xmlfileYoucanderivesomeinformationabouttheTelePresenceServerfromitssystem.
xmlfile.
YoucandownloadthisfileviaHTTPfromtheTelePresenceServer'sroot.
Examplesystem.
xmlTANDBERGTelepresenceServer8710SM0210372.
3(1.
48)13.
0(1.
48)dt12b710.
47.
223.
1272001:420:40ff:ff0a:20d:7cff:fe10:81b800:0D:7C:10:81:B8Yesmainvcs.
test.
laldt12b7,dt12b7-l,dt12b7-c,dt12b7-rYestest.
lalNoYesunclustered121210230641NodenameNodecontentsgatekeeperUsageYes:gatekeeperusageisenabledNo:gatekeeperusageisdisabledgatekeeperAddressThegatekeeperIPaddress.
gatekeeperIdsCommaseparatedlistofregisteredIDsassociatedwiththisTelePresenceServeranditsslaves(omittedifthesystemisnotamaster)sipRegistrarUsageYes:registrarusageisenabledNo:registrarusageisdisabledsipRegistrarAddressTheSIPregistrarIPaddress.
sipRegistrarDomainTheSIPregistrardomainname.
SystemXMLcontentsRelatedinformationCiscoTelePresenceServerAPI2.
3Page72of82NodenameNodecontentssipTrunkUsageYes:trunkusageisenabledNo:trunkusageisdisabledsipTrunkAddressTheSIPtrunkIPaddress.
sipTrunkDomainTheSIPtrunkdomainname.
isMasterDetermineswhetherthissystemcontrolsitsowncallsandconferences.
Thiswillbeeither:Yes:whenclusterTypeisunclusteredormasterNo:whenclusterTypeisslaveclusterTypeTheroleofthissysteminabackplanecluster.
Thiswillbeoneofthefollowing:unclustered,master,orslavetotalVideoPortsThetotalnumberofvideoportssupportedbythedevice.
totalContentPortsThetotalnumberofcontentportssupportedbythedevice.
totalAudioOnlyPortsThetotalnumberofaudioonlyportssupportedbythedevice.
uptimeSecondsThelengthoftimeinsecondsthatthedevicehasbeenupandrunning.
ExampleXML-RPCresponsetoparticipant.
diagnosticsparticipantDiagnosticsResponseparticipantGUID1f983510-8843-11e0-bd5d-000d7c005ce8sourceIdentifierUserPCaudioRxcodecG.
722RelatedinformationCiscoTelePresenceServerAPI2.
3Page73of82encrypted1channelBitRate64000jitter0energy-34packetsReceived6951packetErrors0packetsMissing0framesReceived277960frameErrors0muted0audioTxcodecG.
722RelatedinformationCiscoTelePresenceServerAPI2.
3Page74of82encrypted1channelBitRate64000packetsSent6994muted0auxiliaryAudioRxauxiliaryAudioTxvideoRxcodecH.
264height0width0RelatedinformationCiscoTelePresenceServerAPI2.
3Page75of82encrypted1channelBitRate448000expectedBitRate256000expectedBitRateReasonviewedSizeactualBitRate0jitter0packetsReceived0packetErrors0framesReceived0frameErrors0frameRate0fastUpdateRequestsSent0muted0RelatedinformationCiscoTelePresenceServerAPI2.
3Page76of82videoTxcodecH.
263+height576width704encrypted1channelBitRate448000configuredBitRate448000configuredBitRateReasonnotLimitedactualBitRate47468packetsSent2054frameRate15fastUpdateRequestsReceived2muted0RelatedinformationCiscoTelePresenceServerAPI2.
3Page77of82contentVideoRxcontentVideoTxFaultcodesTheCiscoTelePresenceServerreturnsafaultcodewhenitencountersaproblemwithprocessinganXML-RPCrequest.
ThefollowingtableliststhefaultcodesthatmaybereturnedbytheTelePresenceServerandtheirmostcommoninterpretations.
FaultCodeDescription1Methodnotsupported.
Thismethodisnotsupportedonthisdeviceorisunknown.
2Duplicateconferencename.
Aconferencenamewasspecified,butisalreadyinuse.
4Nosuchconferenceorautoattendant.
Theconferenceorautoattendantidentificationgivendoesnotmatchanyconferenceorautoattendant.
5Nosuchparticipant.
Theparticipantidentificationgivendoesnotmatchanyparticipants.
6Toomanyconferences.
Thedevicehasreachedthelimitofthenumberofconferencesthatcanbeconfigured.
8Noconferencenameorautoattendantidsupplied.
Aconferencenameorautoattendantidentifierwasrequired,butwasnotpresent.
10Noparticipantaddresssupplied.
Aparticipantaddressisrequiredbutwasnotpresent.
RelatedinformationCiscoTelePresenceServerAPI2.
3Page78of8213InvalidPINspecified.
APINspecifiedisnotavalidseriesofdigits.
15Insufficientprivileges.
Thespecifieduseridandpasswordcombinationisnotvalidfortheattemptedoperation.
16InvalidenumerateIDvalue.
AnenumerateIDpassedtoanenumeratemethodinvocationwasinvalid.
Onlyvaluesreturnedbythedeviceshouldbeusedinenumeratemethods.
17Portreservationfailure.
Thereareinsufficientfreeportstocomplete/placetherequestedcalls.
18DuplicatenumericID.
AnumericIDwasgiven,butthisIDisalreadyinuse.
20Unsupportedparticipanttype.
Aparticipanttypewasusedwhichdoesnotcorrespondtoanyparticipanttypeknowntothedevice.
25Newportlimitlowerthancurrentlyactive34InternalerrorAnerroroccurredwhileprocessingtheAPIrequest.
35Stringistoolong.
Thecallsuppliedastringparameterthatwaslongerthanallowed.
Stringsareusuallylimitedto32charactersbutmaybelongerinsomecases.
101Missingparameter.
Thisisgivenwhenarequiredparameterisabsent.
102Invalidparameter.
Thisisgivenwhenaparameterwassuccessfullyparsed,isofthecorrecttype,butfallsoutsidethevalidvalues;forexampleanintegeristoohighorastringvalueforaprotocolcontainsaninvalidprotocol.
103Malformedparameter.
Thisisgivenwhenaparameterofthecorrectnameispresent,butcannotbereadforsomereason;forexampletheparameterissupposedtobeaninteger,butisgivenasastring.
105Requesttoolarge.
ThemethodcallcontainsmoredatathantheAPIcanaccept.
Themaximumsizeofthecallis32kilobytes.
201Operationfailed.
Thisisagenericfaultforwhenanoperationdoesnotsucceedasrequired.
202ProductneedsitsactivationfeaturekeyThisrequestrequiresthattheproductisactivated.
203ToomanyasynchronousrequestsTheTelePresenceServeriscurrentlydealingwiththemaximumnumberofasynchronousrequestsofthistype.
Pleaseretrythisrequestlater.
HTTPkeep-alivesYourapplicationcanuseuseHTTPkeep-alivestoreducetheamountofTCPtrafficthatresultsfromconstantlypollingthedevice.
AnyclientwhichsupportsHTTPkeep-alivesmayincludethefollowinglineintheHTTPheaderofanAPIrequest:Connection:Keep-AliveThisindicatestothedevicethattheclientsupportsHTTPkeep-alives.
ThedevicemaythenchoosetomaintaintheTCPconnectionafterithasresponded.
IfthedevicewillclosetheconnectionitreturnsthefollowingHTTPheaderinitsresponse:Connection:closeRelatedinformationCiscoTelePresenceServerAPI2.
3Page79of82IfthislineisnotintheHTTPheaderoftheresponse,theclientmayusethesameconnectionforasubsequentrequest.
Thedevicewillnotkeepaconnectionaliveif:nthecurrentconnectionhasalreadyservicedtheallowednumberofrequestsnthecurrentconnectionhasalreadybeenopenfortheallowedamountoftimenthenumberofopenconnectionsexceedstheallowednumberifthisconnectionismaintainedTheserestrictionsareinplacetolimittheresourcesassociatedwithopenconnections.
Ifaconnectionisterminatedforeitherofthefirsttworeasons,theclientwillprobablyfindthattheconnectionismaintainedafterthenextrequest.
Note:Theclientshouldneverassumeaconnectionwillbemaintained.
Also,thedevicewillcloseanopenconnectioniftheclientdoesnotmakeanyfurtherrequestswithinaminute.
Thereislittlebenefittokeepingunusedconnectionsopenforsuchlongperiods.
CheckingforupdatesandgettinghelpCiscoTelePresenceServerAPI2.
3Page80of82CheckingforupdatesandgettinghelpIfyouexperienceanyproblemswhenconfiguringorusingtheproduct,consulttheonlinehelpavailablefromtheuserinterface.
Theonlinehelpexplainshowtheindividualfeaturesandsettingswork.
Ifyoucannotfindtheansweryouneed,checkthewebsiteathttp://www.
cisco.
com/cisco/web/support/index.
htmlwhereyouwillbeableto:nmakesurethatyouarerunningthemostup-to-datesoftware,nfindfurtherrelevantdocumentation,forexampleproductuserguides,printableversionsoftheonlinehelp,referenceguides,andarticlesthatcovermanyfrequentlyaskedquestions,ngethelpfromtheCiscoTechnicalSupportteam.
Makesureyouhavethefollowinginformationreadybeforeraisingacase:ltheserialnumberandproductmodelnumberoftheunit(ifapplicable)lthesoftwarebuildnumberwhichcanbefoundontheproductuserinterface(ifapplicable)lyourcontactemailaddressortelephonenumberlafulldescriptionoftheproblemReferencesCiscoTelePresenceServerAPI2.
3Page81of82References1.
XML-RPCspecification(DaveWiner,June1999);http://www.
xmlrpc.
com/spec,accessed24/01/2011.
2.
HTTP/1.
1specification(RFC2616,Fieldingetal.
,June1999);http://www.
ietf.
org/rfc/rfc2616.
txt,accessed24/01/2011.
3.
CiscoTelePresenceCDRlogsreferenceguide(CiscoSystemsInc.
,Sept2012);http://www.
cisco.
com/en/US/docs/telepresence/infrastructure/mcu/admin_guide/cisco_telepresence_infrastructure_cdr_reference_guide.
pdfReferencesCiscoTelePresenceServerAPI2.
3Page82of82THESPECIFICATIONSANDINFORMATIONREGARDINGTHEPRODUCTSINTHISMANUALARESUBJECTTOCHANGEWITHOUTNOTICE.
ALLSTATEMENTS,INFORMATION,ANDRECOMMENDATIONSINTHISMANUALAREBELIEVEDTOBEACCURATEBUTAREPRESENTEDWITHOUTWARRANTYOFANYKIND,EXPRESSORIMPLIED.
USERSMUSTTAKEFULLRESPONSIBILITYFORTHEIRAPPLICATIONOFANYPRODUCTS.
THESOFTWARELICENSEANDLIMITEDWARRANTYFORTHEACCOMPANYINGPRODUCTARESETFORTHINTHEINFORMATIONPACKETTHATSHIPPEDWITHTHEPRODUCTANDAREINCORPORATEDHEREINBYTHISREFERENCE.
IFYOUAREUNABLETOLOCATETHESOFTWARELICENSEORLIMITEDWARRANTY,CONTACTYOURCISCOREPRESENTATIVEFORACOPY.
TheCiscoimplementationofTCPheadercompressionisanadaptationofaprogramdevelopedbytheUniversityofCalifornia,Berkeley(UCB)aspartofUCB'spublicdomainversionoftheUNIXoperatingsystem.
Allrightsreserved.
Copyright1981,RegentsoftheUniversityofCalifornia.
NOTWITHSTANDINGANYOTHERWARRANTYHEREIN,ALLDOCUMENTFILESANDSOFTWAREOFTHESESUPPLIERSAREPROVIDED"ASIS"WITHALLFAULTS.
CISCOANDTHEABOVE-NAMEDSUPPLIERSDISCLAIMALLWARRANTIES,EXPRESSEDORIMPLIED,INCLUDING,WITHOUTLIMITATION,THOSEOFMERCHANTABILITY,FITNESSFORAPARTICULARPURPOSEANDNONINFRINGEMENTORARISINGFROMACOURSEOFDEALING,USAGE,ORTRADEPRACTICE.
INNOEVENTSHALLCISCOORITSSUPPLIERSBELIABLEFORANYINDIRECT,SPECIAL,CONSEQUENTIAL,ORINCIDENTALDAMAGES,INCLUDING,WITHOUTLIMITATION,LOSTPROFITSORLOSSORDAMAGETODATAARISINGOUTOFTHEUSEORINABILITYTOUSETHISMANUAL,EVENIFCISCOORITSSUPPLIERSHAVEBEENADVISEDOFTHEPOSSIBILITYOFSUCHDAMAGES.
CiscoandtheCiscoLogoaretrademarksofCiscoSystems,Inc.
and/oritsaffiliatesintheU.
S.
andothercountries.
AlistingofCisco'strademarkscanbefoundatwww.
cisco.
com/go/trademarks.
Thirdpartytrademarksmentionedarethepropertyoftheirrespectiveowners.
TheuseofthewordpartnerdoesnotimplyapartnershiprelationshipbetweenCiscoandanyothercompany.
(1005R)AnyInternetProtocol(IP)addressesandphonenumbersusedinthisdocumentarenotintendedtobeactualaddressesandphonenumbers.
Anyexamples,commanddisplayoutput,networktopologydiagrams,andotherfiguresincludedinthedocumentareshownforillustrativepurposesonly.
AnyuseofactualIPaddressesorphonenumbersinillustrativecontentisunintentionalandcoincidental.
2012CiscoSystems,Inc.
Allrightsreserved.