TANDBERG Codian Remote Management API, Reference Manual

Page 1: ...Reference guide Codian Remote Management API Document version 3 0 September 2008...

Page 2: ...Copyright TANDBERG 2008 TANDBERG Philip Pedersens vei 20 1366 Lysaker Norway Telephone 47 67 125 125 Telefax 47 67 125 234 Video 47 67 117 777 E mail tandberg tandberg com www tandberg com...

Page 3: ...onference related methods 14 4 1 conference create 14 4 2 conference modify 16 4 3 conference destroy 17 4 4 conference end 17 4 5 conference enumerate 17 4 6 conference streaming query 20 4 7 confere...

Page 4: ...Related information sources 47 9 1 system xml 47 10 Required user privileges 48 11 Fault codes 49 12 Participant disconnect reasons 51 13 References52 Appendix A Conference layouts 53 Appendix B Linki...

Page 5: ...version API Version MCU 4200 MCU 4500 Media blades IP VCR 2200 Recording blade Codian ISDN Gateway 3200 3201 MSE 8320 MSE 8321 IP Gateway 3500 Series IP Gateway MSE 8350 blade 2 4 2 2 2 2 1 3 2 5 2 3...

Page 6: ...RPC spec the device responds with a message indicating success or failure The response message may also contain any data that was requested Command messages are sent in XML format For example the fol...

Page 7: ...nt Type text xml Content Length 240 xml version 1 0 methodResponse params param value struct member name status name value string operation successful string value member struct value param params met...

Page 8: ...assumed 2 3 1 HTTP Headers There are two different ways of specifying unicode in the HTTP headers either using Accept Encoding utf 8 or modifying the Content Type header to read Content Type text xml...

Page 9: ...d endpoint irrespective of whether the endpoint dialed in or the MCU dialed out API created participants in scheduled conferences i e those originated by participant add will be of type by_address unl...

Page 10: ...herwise If the result of evaluating the filter is true the entity is returned to the client If the expression evaluates to false the entity in question is not returned to the client and the next entit...

Page 11: ...Copyright TANDBERG 2008 Reference Guide Version 3 0 rev 3 0 7 Operator Description Unary minus Unary plus Logical negation Bitwise negation An example filter would be expression1 expression2...

Page 12: ...ins a string feature with a short description of the feature totalVideoPorts Integer The total number of video ports on the device Only present on MCU and VCR products totalAudioOnlyPorts Integer The...

Page 13: ...String 64 bit versions of the above stats using a string rather than an integer All fields above marked optional will be returned only if the interface has been enabled and has been configured 3 3 dev...

Page 14: ...efix String The registration prefix used by the device h323ID String The h323 id used by the device mcuServicePrefix String The service prefix used by the device scheduledConferenceIDRegistration Stri...

Page 15: ...s See below for details The array addressBookEntries contains structs with the following fields Field Type Comments Name String The configuration s name address String 32 chars The participant s E 164...

Page 16: ...Boolean If true this endpoint will use box wide layout control settings layoutControlEnabled Boolean Only present if layoutControlDefault is false Indicates whether the participant will have control...

Page 17: ...String The name of the configured gateway address String 32 chars The gateway s E 164 directory number hostname or IP address conferencingParameters struct see below The structure conferencingParamete...

Page 18: ...tional Integer The length of each repeating conference instance in seconds If this parameter is absent or set to 0 the conference is permanent endTime optional deprecated dateTime iso8601 If you do no...

Page 19: ...String Must be present if repetition is weekly or everyTwoWeeks A comma separated string of weekdays i e any of monday tuesday wednesday thursday friday saturday or sunday e g monday wednesday friday...

Page 20: ...me String 32 chars Name of the conference to modify newConferenceName optional String 32 chars If present the conference will be renamed to specified value oldConferenceName deprecated String 32 chars...

Page 21: ...nly a very limited amount of control available for ad_hoc conferences however 4 3 conference destroy Parameter Type Comments conferenceName String Name of the conference to be destroyed A conference c...

Page 22: ...niqueId conferenceActive Boolean Indicates whether conference is currently active description String Extra user specified information about the conference pin String The security PIN guestPin String S...

Page 23: ...nt if repetition is monthly One of first the first X of the month where X is the day specified by weekday second third fourth or last i e last X of the month weekDays optional String A comma separated...

Page 24: ...number of RTCP packets send by the MCU videoRTCPReceiverReports Integer videoRTCPSenderReports Integer videoRTCPOther Integer As for the audio equivalents videoRTCPPacketsSent Integer The actual layou...

Page 25: ...sent if focusType is participant 4 8 conference paneplacement query Queries the current pane placement configuration Parameter Type Comments conferenceName String The name of the conference to be quer...

Page 26: ...to the configured rolling interval h239 the h239 content channel participant a participant as described in the three optional fields participantType optional String participantProtocol optional String...

Page 27: ...s kBit s maxBitRateFromMCU Integer The maximum bit rate from the MCU specified as kBit s motionSharpnessTradeoff String One of default to use the global default setting preferMotion preferSharpness an...

Page 28: ...address All participants in a conference must have a participantName that is unique to the conference but it need not be unique across all conferences Participants can be added before or during a conf...

Page 29: ...operationScope String One of activeState or configuredState This parameter specifies the scope of the changes to be made be they to the configured state of an endpoint or to the active state of a part...

Page 30: ...nnection set to true but can also be used to reconnect disconnected participants Parameter Type Comments conferenceName String autoAttendantUniqueId String participantName String participantProtocol S...

Page 31: ...h of currentState or configuredState If currentState is present the active configuration of each participant is returned by the MCU in the currentState structure If configuredState is present the stor...

Page 32: ...default tcp udp or tls password String The password for vnc endpoints deferConnection Boolean true if this participant s connection is being deferred displayNameOverrideStatus Boolean Indicates wheth...

Page 33: ...he global default setting preferMotion preferSharpness and balanced callState String One of dormant alerting connected or disconnected When dormant the callDirection field is not returned connectTime...

Page 34: ...to this participant This parameter will not be present if the participant is in an auto attendant rather than a conference or if the MCU is not currently transmitting video to the participant in quest...

Page 35: ...value in the range 30000 30dB for very quiet and 0 very loud audioRxMutedRemotely Boolean Whether this endpoint is muted remotely Note This participant information is returned for all participants add...

Page 36: ...rns the following Response Type Comments videoTxFrameRate Integer videoRxFrameRate Integer videoRxFramesReceived Integer videoTxChannelBitRate Integer videoTxSelectedBitRate Integer videoTxActualBitRa...

Page 37: ...array called autoAttendants of structs which contains Response Type Comments autoAttendantUniqueID String autoAttendantConfiguredName String If this participant is connected to an auto attendant this...

Page 38: ...protocol is sip Defaults to false This may give an operation failed fault with a reason given in the fault string if the operation fails In IP VCR release 2 3 and later if this call succeeds then the...

Page 39: ...s Boolean True if the recording is in the process of being made This returns the following Response Type Comments enumerateID optional String An enumerateID as specified in section 2 recordings array...

Page 40: ...ures See below for layout of the structures The folders array contains the following structures Field Type Comments folderName String The name of the folder folderId Integer A unique identifier for th...

Page 41: ...ersion 3 0 rev 3 0 37 Field Type Comments pointToPointIncomingPrefix String pointToPointOutgoingPrefix String The folder s configured point to point recording prefixes These values are only present wi...

Page 42: ...audioCodec String The audio codec used for this participant progress String The state of the connection to this participant One of none initial proceeding alerting connected or finished Only present...

Page 43: ...regationCall Boolean True if this is an aggregation call false otherwise callProgress String The state of the call One of initial calling out connected or dying encryption String Either all some or no...

Page 44: ...there is no maximum this value is 0 calledNumber String The number originally called or unknown if this number is unknown The calling and called party are as defined above 6 4 isdn ports query Return...

Page 45: ...eld Type Comments id Integer The channel index active Boolean True if this channel is active voice Boolean True if this a voice call false if a data call Only present if active incoming Boolean True i...

Page 46: ...8350 blade 7 1 corpdirURI query There are no parameters passed with this method call The method response returns the following Parameter Type Comments corpdirURI String The full path of the TMS addre...

Page 47: ...teger The number of participants that have ever left the conference The difference between numJoined and numLeft gives the number of current participants Note that until conference destroy is called f...

Page 48: ...e whilst they are connected but not after they have disconnected 8 3 conference participant modify This method has been deprecated in favour of participant modify See participant modify for details of...

Page 49: ...participant has disconnected disconnectReason String Only returned after the participant has disconnected one of the disconnect reason values given in section 12 connectPending boolean true if a part...

Page 50: ...rrentLayout Integer Actual layout in use for the video stream being sent by the MCU to this participant This parameter will not be present if the participant is in an auto attendant rather than a conf...

Page 51: ...on uptimeSeconds 2345 uptimeSeconds system The meaning of the fields is Field Comments manufacturer The manufacturer of this MCU i e Codian model The model of this particular MCU e g MCU 4210 serial T...

Page 52: ...with administrator privileges participant add Any user with administrator privilege the owner of the conference or a user with conference creation and full control rights autoAttendant enumerate auto...

Page 53: ...e is not valid 13 Invalid PIN specified A PIN specified is not a valid series of digits 14 Unauthorised The requested operation is not permitted on this device 15 Insufficient privileges The specified...

Page 54: ...n the fault string in the format invalid parameter parameter_name 103 Malformed parameter This is given when a parameter of the correct name is present but cannot be read for some reason for example t...

Page 55: ...rotocolError dnsFailed destinationUnreachable gatekeeperEnded videoPortAllocationExceeded portAllocationExceeded disconnectAll incompatibleVncVersion failedToConnectToServer authenticationFailed servi...

Page 56: ...Copyright TANDBERG 2008 Reference Guide Version 3 0 rev 3 0 52 13 References 1 XML RPC http www xmlrpc com 2 RFC 2616 http www faqs org rfcs rfc2616 html...

Page 57: ...family family index use the specified layout family see below layout index use a specific layout see below conferenceCustom use the conference custom layout The index values for family index correspo...

Page 58: ...Copyright TANDBERG 2008 Reference Guide Version 3 0 rev 3 0 54 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59...

Page 59: ...ely on the target MCU s gatekeeper usage is to call from mcu1 into the target conference using mcu2 as a gateway and the target conference s numeric id as the remote address The participant addition i...

Page 60: ...ruct value param params methodCall B 2 Example message 2 creating conference linked2 on mcu2 xml version 1 0 methodCall methodName conference create methodName params param value struct member name au...

Page 61: ...er name value string admin string value member member name conferenceName name value string linked1 string value member member name participantName name value string remote_mcu string value member mem...

Page 62: ...param value struct member name authenticationUser name value string admin string value member member name conferenceName name value string linked2 string value member member name participantName name...

Page 63: ...onses The response to each of the above method invocations should be the same normal success indication xml version 1 0 methodResponse params param value struct member name status name value string op...

Page 64: ...ged since this revision number should be returned For example in participant enumerate if a lastRevision parameter is provided then the enumeration response will only include participants that have ch...

Page 65: ...s removed in this way will contain a field named changed instead which will be set to false indicating that there are no changes to the data in this substructure since the specified revision number C...

Page 66: ...his line indicates that the device will keep the TCP connection open and that the client may use the same connection for a subsequent request The device will not allow a connection to be kept alive if...