TANDBERG D13639 manual DialGroupEntry DialInNumberAdd DialInNumberRemove, Parameters Conferencer

Page 57

DialGroupEntry

DialInNumberAdd

DialInNumberRemove

TANDBERG MPS API

User Guide

OK

Command used to dial an entry from the Group Directory. Dialing from the Group Directory makes it possible to set up a MultiSite conference in one operation.

Parameters:

Conference(r): <1..35>

GroupEntryId(r): <1..16> Reference to the directory entry to be dialed.

OK Result parameters:

The system will return the following elements for each call initiated.

CallRef: <1..96> Reference to the call. To be used as reference when monitoring the call.

LogTag: <1…> Unique reference to call. Identifies the call in the call log.

ERROR Result parameters:

Cause: <1…> Cause code specifying why the call was not accepted by the system

Description Textual description of the cause code.

Example:

xcommand dialgroupentry conference:1 groupentryid:19

*r Result (status=OK): CallRef: 2 LogTag: 313 CallRef: 1 LogTag: 312 CallRef:

*r/end

OK

Command used to add a dial in number.

Parameters:

Conference(r): <1..15>

NetProfile(r): <2..7>

Number(r): <S: 0, 60>

CallerId: <S: 0, 60>

ERROR Result parameters:

Cause: <1…> Cause code specifying why the call was not accepted by the system

Description Textual description of the cause code.

Command used to remove a dial in number.

Parameters:

Conference(r): <1..15>

NetProfile(r): <2..7>

Number(r): <S: 0, 60>

CallerId: <S: 0, 60>

ERROR Result parameters:

55

Image 57
Contents User Guide Tandberg MPS APITable of Contents Disclaimer Tandberg APIExample Introduction to XMLExample Tandberg MPS API Introduction to XML Path Language XPath Status/Call@status=Synced/CallRate Tandberg XML Engine Addressing using XPathStructuring of Information FeedbackTandberg MPS API XML Documents DocumentsStatus Documents r Configuration documents rw Command documents w Command Dial item=1 Number item=1999/Number /Dial Example Bare-bone Https access Introduction to Tandberg XML API Service TxasGetxml FormputxmlExercise ExercisesTandberg MPS API XML-based Advanced Command Line Interface Accessing Xacli Root commandsAddressing Exposure options Supported exposure optionsXstatus call Misc Format Status-type root commands Xstatus / xhistoryXstatus ? Xstatus call 1 remotenumberXacli *s IP XMLConfiguration help Configuration-type root commands xconfiguration/xdirectoryXconfiguration ? Xdirectory ?Configuration read Configuration set writeXconfiguration // ? Xconfiguration ?? Xconfiguration ip/assignment static Command help Command-type root commands xcommandXcommand ? Xcommand ??Example 2.12 xcommand Dial ? Issuing a commandXcommand dial number666 restricton callrate128 subaddress10 Xcommand dial nu666 ron c128 s10Xcommand dial 666 10 128 on Xcommand dial 666 ron 10Xcommand dial Xgetxml status/ip XML Output xgetxmlXfeedback Special CommandsXfeedback ? Xfeedback register status/call/channels/audio/protocolXfeedback register status/call@status=Disconnected Xcom dial Xfeedback register status/call Xcom dialXfeedback register status/call@status=Synced Xcom dial Xcom discXpreferences ? XpreferencesXpreferences detaillevel Xstat call 1 channels 1 audio Xstat call 1 channels 1 audioBaudRate item=12400/BaudRate API Configurations Configuration.xml xconfiguration Tandberg MPS API Tandberg MPS API Http Mode On/Off H323Gatekeeper 1..2 Authentication Password S 0Tandberg MPS API MCU LoS Polarity Positive/Negative LoS RetrySerialInterfaceCard Session RTPSIP Interface Authentication UserName S 0 SIP Mode On/OffSIP Interface Authentication Password S 0 SIP Interface Transport Default TCP/UDPTandberg MPS API Directory.xml xdirectory API Commands Command.xml xcommand CallMuteOutgoing CallTransfer CallTransferToDirEntry Parameters Conferencer OK Result parameters CallMuteVideo ConferenceDisconnect ConferenceModifyConferenceRedefine ConferenceStart ConferenceStop ConferenceShowDuration ConferenceTerminate DefaultValuesSet Dial DialGroupEntry DialInNumberAdd DialInNumberRemove Parameters ConferencerDescription Textual description of the cause code DialLocalEntry DisconnectCall DisconnectGWCall FeedbackDeregister FeedbackRegister OK Result parameters Error Result parametersParameters Name S 0, 48 The entry’s name FloorToSite FloorToSiteEnd GroupEntryAddGroupEntryDelete LayoutLock LayoutUnLock Windowr CallIDr 1..176 Call Error Result parameters LocalEntryAdd LocalEntryDeleteNetworkId NetworkModule OK Result parameters Command used to add option key ProtectNumberRemove VideoTextSet API Status Examples Status.xml xstatusTandberg MPS API Examples Tandberg MPS API Mcuid Feedback Top level attributes Ethernet Top level attributesEnd User GuideNone MediaBoard 1..8 Top level attributesSystemUnit Top level attributes None Summary Top level attributes Status on/off Summary SerialInterfaceCard ISDNInterfaceCardTandberg MPS API Tandberg MPS API NTP SIP SystemLoad SystemClock SystemActivity Options Option Option 64 / *s/end Conference Top level attributes History.xml xhistoryEvent.xml xevent TotalPackets AudioPacketLoss PacketsDroppedEnd