List of R2D2 Commands: Difference between revisions

From Ultiroam User Docs
Jump to navigation Jump to search
VisualWikitext
(Created page with "{| class="wikitable sortable" |- !Command !! Input arguments !! Returns !! Category {{:BackupCDR Synopsis}}||CDR {{:DeletePortLogs Synopsis}}||CDR {{:GetCDR Synopsis}}||CDR {{:GetCdrLine Synopsis}}||CDR {{:ResetCDR Synopsis}}||CDR {{:StartPortLog Synopsis}}||CDR {{:StopPortLog Synopsis}}||CDR {{:ConnectData Synopsis}}||Data {{:ConnectFtp Synopsis}}||Data {{:ConnectHttp Synopsis}}||Data {{:DisconnectData Synopsis}}||Data {{:DisconnectFtp Synopsis}}||Data {{:ExecuteHttpMe...")
Tag: 2017 source edit
 
No edit summary
Tag: 2017 source edit
 
(57 intermediate revisions by the same user not shown)
Line 1: Line 1:
{| class="wikitable sortable"
{| class="wikitable sortable"
! R2D2 Command !! Description
!Input Arguments
!Returns
!Category
|-
|-
!Command !! Input arguments !! Returns !! Category
| [[BackupCDR|BackupCDR]]|| Backup CDR files
{{:BackupCDR Synopsis}}||CDR
|BackupFileName
{{:DeletePortLogs Synopsis}}||CDR
|[[R2D2 Error Codes|Error Code]] in case of error
{{:GetCDR Synopsis}}||CDR
|CDR
{{:GetCdrLine Synopsis}}||CDR
|-
{{:ResetCDR Synopsis}}||CDR
|[[DeletePortLogs|DeletePortLogs]]
{{:StartPortLog Synopsis}}||CDR
|Delete Logs of a Port
{{:StopPortLog Synopsis}}||CDR
|PortIndex
 
|[[R2D2 Error Codes|Error Code]] in case of error
{{:ConnectData Synopsis}}||Data
|Logs
{{:ConnectFtp Synopsis}}||Data
|-
{{:ConnectHttp Synopsis}}||Data
|[[GetCDR|GetCDR]]
{{:DisconnectData Synopsis}}||Data
|Get CDR File Path
{{:DisconnectFtp Synopsis}}||Data
|None.
{{:ExecuteHttpMethod Synopsis}}||Data
|CDR File Path
{{:GetDataParameters Synopsis}}||Data
|CDR
{{:GetDataStatus Synopsis}}||Data
|-
{{:GetNumberOfPopMessages Synopsis}}||Data
|[[GetCDRLine|GetCDRLine]]
{{:ReceiveFtpFile Synopsis}}||Data
|Get Line of CDR File
{{:ReceivePopMessage Synopsis}}||Data
|PortIndex CdrFileName LineNumber
{{:SendFtpFile Synopsis}}||Data
|CdrLine, [[R2D2 Error Codes|Error Code]] in case of error
{{:SendMmsMessage Synopsis}}||Data
|CDR
{{:SendSmtpFileMessage Synopsis}}||Data
|-
{{:  SendSmtpTextMessage Synopsis}}||Data
|[[ResetCDR|ResetCDR]]
{{:  SetDataParameters Synopsis}}||Data
|Purges CDR, GSM and Data Logs
{{:  SetFtpParameters Synopsis}}||Data
|None.
{{:  SpeedTest Synopsis}}||Data
|None.
{{:  StreamVideo Synopsis}}||Data
|CDR
 
|-
{{:  FxoAcceptAndRecord Synopsis}}||FXO
|[[StartPortLog|StartPortLog]]
{{:  FxoAcceptCall Synopsis}}||FXO
|Start Log for a Port
{{:  FxoCallState Synopsis}}||FXO
|PortIndex UniqueID
{{:  FxoHangupCall Synopsis}}||FXO
|[[R2D2 Error Codes|Error Code]] in case of error
{{:  FxoPlaceCall Synopsis}}||FXO
|Logs
{{:  FxoPlaceCallAndPlay Synopsis}}||FXO
|-
{{:  FxoPlay Synopsis}}||FXO
|[[StopPortLog|StopPortLog]]
{{:  FxoRecord Synopsis}}||FXO
|Stop Log for a Port
{{:  FxoStopRecording Synopsis}}||FXO
|PortIndex UniqueID
{{:  FxoWaitCall Synopsis}}||FXO
|[[R2D2 Error Codes|Error Code]] in case of error
{{:  FxoWaitCallAndRecord Synopsis}}||FXO
|Logs
 
|-
{{:  ExecuteShellCommand Synopsis}}||General Purpose
|[[GsmRegistrationMode|GsmRegistrationMode]]
{{:  FirmwareUpdate Synopsis}}||General Purpose
|Set/Get GSM Auto Registration Mode
{{:  GetCallInfo Synopsis}}||General Purpose
|Port index [Registration mode]
{{:  GetCallState Synopsis}}||General Purpose
|Command status or Registration mode
{{:  GetGeneralTimeout Synopsis}}||General Purpose
|Network
{{:  GetGsmAdapterType Synopsis}}||General Purpose
|-
{{:  GetGsmPortStatus Synopsis}}||General Purpose
|[[GetModemInfo|GetModemInfo]]
{{:  GetGsmRobotApiVersion Synopsis}}||General Purpose
|Get Modem Informations
{{:  GetListOfApiFunctions Synopsis}}||General Purpose
|PortIndex
{{:  GetModemInfo Synopsis}}||General Purpose
|Modem informations
{{:  GetNumberOfGsmAdapters Synopsis}}||General Purpose
|General
{{:  GetNumberOfGsmPorts Synopsis}}||General Purpose
|-
{{:  GsmAdapterPowerSupplyOff Synopsis}}||General Purpose
|[[ImsiAttach|ImsiAttach]]
{{:  GsmPortPowerSupplyOff Synopsis}}||General Purpose
|Attach a SIM to the Network
{{:  SendAtCommand Synopsis}}||General Purpose
|PortIndex
{{:  SetGeneralTimeout Synopsis}}||General Purpose
|[[R2D2 Error Codes|Error Code]] in case of error
{{:  StartGsmPort Synopsis}}||General Purpose
|Network
{{:  StartPcapTrace Synopsis}}||General Purpose
|-
{{:  StopGsmPort Synopsis}}||General Purpose
|[[ImsiDetach|ImsiDetach]]
{{:  StopPcapTrace Synopsis}}||General Purpose
|Detach a SIM from the Network
 
|PortIndex
 
|[[R2D2 Error Codes|Error Code]] in case of error
{{:  GetGpsData Synopsis}}||GPS
|Network
{{:  TurnOffGps Synopsis}}||GPS
|-
{{:  TurnOnGps Synopsis}}||GPS
|[[ImsiStatus|ImsiStatus]]
{{:  AcceptCall Synopsis}}||GSM Voice Call
|Get SIM Registration status
{{:  HangupCall Synopsis}}||GSM Voice Call
|PortIndex
{{:  PlaceCall Synopsis}}||GSM Voice Call
|IMSI status (ATTACHED or DETACHED)
{{:  PlaceCallAndPlay Synopsis}}||GSM Voice Call
|Network
{{:  PlaceCallAndWaitConnect Synopsis}}||GSM Voice Call
|-
{{:  PlaceShortCall Synopsis}}||GSM Voice Call
|[[StartGsmPort|StartGsmPort]]
{{:  PlayVoice Synopsis}}||GSM Voice Call
|Open/Start a GSM Port
{{:  RecordVoice Synopsis}}||GSM Voice Call
|PortIndex
{{:  SendDtmf Synopsis}}||GSM Voice Call
|[[R2D2 Error Codes|Error Code]] in case of error
{{:  StopRecording Synopsis}}||GSM Voice Call
|General
{{:  WaitAcceptCallAndRecord Synopsis}}||GSM Voice Call
|-
{{:  WaitAndAcceptCall Synopsis}}||GSM Voice Call
|[[StopGsmPort|StopGsmPort]]
{{:  WaitAndRejectCall Synopsis}}||GSM Voice Call
|Close/Stop a GSM Port
{{:  WaitCall Synopsis}}||GSM Voice Call
|PortIndex
{{:  GetAccessTechnology Synopsis}}||Network
|[[R2D2 Error Codes|Error Code]] in case of error
{{:  GetDedicatedChannelInfo Synopsis}}||Network
|General
{{:  GetGsmCurrentOperator Synopsis}}||Network
|-
{{:  GetGsmOperatorList Synopsis}}||Network
|[[SendAtCommand|SendAtCommand]]
{{:  GetNeighborCellsInfo Synopsis}}||Network
|Send AT Command to GSM Port
{{:  GetNeighborCellsInfoVerbose Synopsis}}||Network
|PortIndex ATCommand
{{:  GetServingCellInfo Synopsis}}||Network
|Response from the GSM modem
{{:  GetServingCellInfoVerbose Synopsis}}||Network
|General
{{:  GsmRegistrationMode Synopsis}}||Network
|-
{{:  IMSIAttach Synopsis}}||Network
|[[SendSmsText|SendSmsText]]
{{:  IMSIDetach Synopsis}}||Network
|Send a specified Text as a SMS
{{:  IMSIStatus Synopsis}}||Network
|PortIndex Number SMS text [SMSC [Timeout]]   
{{:  SelectGsmBand Synopsis}}||Network
|[[R2D2 Error Codes|Error Code]] in case of error
{{:  SelectGsmOperator Synopsis}}||Network
|SMS
{{:  SetAccessTechnology Synopsis}}||Network
|-
{{:  SetServingCell Synopsis}}||Network
|[[GetSmsCenter|GetSmsCenter]]
{{:  DisablePinLock Synopsis}}||SIM
|Get SMS Centers numbers
{{:  EnablePinLock Synopsis}}||SIM
|PortIndex
{{:  EnterPUKCode Synopsis}}||SIM
|SMS Centers Numbers
{{:  GetIMEI Synopsis}}||SIM
|SMS
{{:  GetPinLockStatus Synopsis}}||SIM
|-
{{:  GetSimICCID Synopsis}}||SIM
|[[SetSmsCenter|SetSmsCenter]]
{{:  GetSimIMSI Synopsis}}||SIM
|Set SMS Center Number
{{:  GetSimLocation Synopsis}}||SIM
|PortIndex SMSNumber
{{:  GetSimTMSI Synopsis}}||SIM
|[[R2D2 Error Codes|Error Code]] in case of error
{{:  ReadEccFile Synopsis}}||SIM
|SMS
{{:  ReadKcFile Synopsis}}||SIM
|-
{{:  ReadLociFile Synopsis}}||SIM
|[[ConnectData|ConnectData]]
{{:  SetDefaultPinCode Synopsis}}||SIM
|Establish Data Connection
{{:  SetEccFile Synopsis}}||SIM
|PortIndex
{{:  SetKcFile Synopsis}}||SIM
|[[R2D2 Error Codes|Error Code]] in case of error
{{:  SetLociFile Synopsis}}||SIM
|Data
{{:  SetSimLocation Synopsis}}||SIM
|-
{{:  GsmRoutePrint Synopsis}}||SIP
|[[GetDataStatus|GetDataStatus]]
{{:  RouteGsmPortToSip Synopsis}}||SIP
|Get Status of the Data Connection
{{:  RouteSipToGsmPort Synopsis}}||SIP
|PortIndex
{{:DecodePdu Synopsis}}||SMS
|Data Status
{{:GetSmsCenter Synopsis}}||SMS
|Data
{{:  SendSmsPdu Synopsis}}||SMS
|-
{{:  SendSmsPduAndWaitDelivery Synopsis}}||SMS
|[[SetDataParameters|SetDataParameters]]
{{:  SendSmsText Synopsis}}||SMS
|Set Data Connection parameters
{{:  SendSmsTextAndWaitDelivery Synopsis}}||SMS
|Port index APN UserName Password [...]
{{:  SetSmsCenter Synopsis}}||SMS
|[[R2D2 Error Codes|Error Code]] in case of error
{{:  SimMemoryPurge Synopsis}}||SMS
|Data
{{:  StartSmsReceiving Synopsis}}||SMS
|-
{{:  StopSmsReceiving Synopsis}}||SMS
|[[GetDataParameters|GetDataParameters]]
{{:  WaitAndReceiveSms Synopsis}}||SMS
|Get Data Connection Parameters
{{:  CheckCallForwarding Synopsis}}||Supplementary Services
|PortIndex
{{:  CheckForwardings Synopsis}}||Supplementary Services
|[[R2D2 Error Codes|Error Code]] in case of error
{{:  ClearCallForwarding Synopsis}}||Supplementary Services
|Data
{{:  DisableCallBarring Synopsis}}||Supplementary Services
|-
{{:  DisableCallForwarding Synopsis}}||Supplementary Services
|[[DisconnectData|DisconnectData]]
{{:  EnableCallBarring Synopsis}}||Supplementary Services
|Disconnect Data Connection
{{:  EnableCallForwarding Synopsis}}||Supplementary Services
|PortIndex
{{:  GetCallBarringStatus Synopsis}}||Supplementary Services
|[[R2D2 Error Codes|Error Code]] in case of error
{{:  GetCallWaiting Synopsis}}||Supplementary Services
|Data
{{:  RegisterCallForwarding Synopsis}}||Supplementary Services
|-
{{:  SetCallWaiting Synopsis}}||Supplementary Services
|[[AcceptCall|AcceptCall]]
{{:  SwitchCall Synopsis}}||Supplementary Services
|Accept a Call
{{:  CloseUSSDSession Synopsis}}||USSD
|PortIndex
{{:  GetUSSDPush Synopsis}}||USSD
|Status (CONNECTED or NO INCOMING CALL)
{{:  GetUSSDResponse Synopsis}}||USSD
|Voice
{{:  GetUSSDTimeout Synopsis}}||USSD
|-
{{:  OpenUSSDSession Synopsis}}||USSD
|[[GetGsmAudioMode|GetGsmAudioMode]]
{{:  SendUSSDCommand Synopsis}}||USSD
|Get the port audio mode
{{:  SetUSSDTimeout Synopsis}}||USSD
|PortIndex
 
|Audio mode configured
{{:ConfigureVolte Synopsis}}||VoLTE
|Voice
{{:GetMbnList Synopsis}}||VoLTE
|-
{{:GetVolteParameters Synopsis}}||VoLTE
|[[HangupCall|HangupCall]]
{{:GetVolteStatus Synopsis}}||VoLTE
|Hangs up an existing call
{{:SetVolteParameters Synopsis}}||VoLTE
|PortIndex
{{:UploadMbnFile Synopsis}}||VoLTE
|[[R2D2 Error Codes|Error Code]] in case of error
{{:WaitVolteRegistration Synopsis}}||VoLTE
|Voice
|-
|[[PlaceCall|PlaceCall]]
|Place a call
|PortIndex, DetinationNumber
|[[R2D2 Error Codes|Error Code]] in case of error
|Voice
|-
|[[PlaceCallAndPlay|PlayCallAndPlay]]
|Place a call and play a wav file
|PortIndex,DestinationNumber,WavFile,CallDuration,[Timeout]
|Call Status, [[R2D2 Error Codes|Error Code]] in case of error
|Voice
|-
|[[PlaceCallAndWaitConnect|PlaceCallAndWaitConnect]]
|Place a call and wait until call is connected
|PortIndex,DestinationNumber,Timeout]
|Call Status
|Voice
|-
|[[PlaceShortCall|PlaceShortCall]]
|Place a call and disconnect within one second
|PortIndex,DestinationNumber,Duration(ms)
|[[R2D2 Error Codes|Error Code]] in case of error
|Voice
|-
|[[PlayVoice|PlayVoice]]
|Disconnect Data Connection
|PortIndex,WavFileToPlay,[PlayEverFlag]
|[[R2D2 Error Codes|Error Code]] in case of error
|Voice
|-
|[[RecordVoice|RecordVoice]]
|Disconnect Data Connection
|PortIndex,WavFile,[PCMSampleRate16bits]
|[[R2D2 Error Codes|Error Code]] in case of error
|Voice
|-
|[[SendDtmf|SendDtmf]]
|Play a set of DTMF
|PortIndex,DTMFSequence
|[[R2D2 Error Codes|Error Code]] in case of error
|Voice
|-
|[[StopRecording|StopRecording]]
|Stop voice recording
|PortIndex
|[[R2D2 Error Codes|Error Code]] in case of error
|Voice
|-
|[[WaitAcceptCallAndRecord|WaitAcceptCallAndRecord]]
|Wait Call and record audio file
|PortIndex,WavFile,[Timeout],[PCM16Flag]
|Calling Number, [[R2D2 Error Codes|Error Code]] in case of error
|Voice
|-
|[[WaitAndAcceptCall|WaitAndAcceptCall]]
|Wait incoming call and connect it
|PortIndex, [Timeout]
|Calling Number,[[R2D2 Error Codes|Error Code]] in case of error
|Voice
|-
|[[WaitAndRejectCall|WaitAndRejectCall]]
|Wait incoming call and reject it
|PortIndex, [Timeout], [Reject Cause]
|Calling Number,[[R2D2 Error Codes|Error Code]] in case of error
|Voice
|-
|[[WaitCall|WaitCall]]
|Wait call
|PortIndex
|[[R2D2 Error Codes|Error Code]] in case of error
|Voice
|}
|}

Latest revision as of 10:55, 27 March 2025

R2D2 Command Description Input Arguments Returns Category
BackupCDR Backup CDR files BackupFileName Error Code in case of error CDR
DeletePortLogs Delete Logs of a Port PortIndex Error Code in case of error Logs
GetCDR Get CDR File Path None. CDR File Path CDR
GetCDRLine Get Line of CDR File PortIndex CdrFileName LineNumber CdrLine, Error Code in case of error CDR
ResetCDR Purges CDR, GSM and Data Logs None. None. CDR
StartPortLog Start Log for a Port PortIndex UniqueID Error Code in case of error Logs
StopPortLog Stop Log for a Port PortIndex UniqueID Error Code in case of error Logs
GsmRegistrationMode Set/Get GSM Auto Registration Mode Port index [Registration mode] Command status or Registration mode Network
GetModemInfo Get Modem Informations PortIndex Modem informations General
ImsiAttach Attach a SIM to the Network PortIndex Error Code in case of error Network
ImsiDetach Detach a SIM from the Network PortIndex Error Code in case of error Network
ImsiStatus Get SIM Registration status PortIndex IMSI status (ATTACHED or DETACHED) Network
StartGsmPort Open/Start a GSM Port PortIndex Error Code in case of error General
StopGsmPort Close/Stop a GSM Port PortIndex Error Code in case of error General
SendAtCommand Send AT Command to GSM Port PortIndex ATCommand Response from the GSM modem General
SendSmsText Send a specified Text as a SMS PortIndex Number SMS text [SMSC [Timeout]] Error Code in case of error SMS
GetSmsCenter Get SMS Centers numbers PortIndex SMS Centers Numbers SMS
SetSmsCenter Set SMS Center Number PortIndex SMSNumber Error Code in case of error SMS
ConnectData Establish Data Connection PortIndex Error Code in case of error Data
GetDataStatus Get Status of the Data Connection PortIndex Data Status Data
SetDataParameters Set Data Connection parameters Port index APN UserName Password [...] Error Code in case of error Data
GetDataParameters Get Data Connection Parameters PortIndex Error Code in case of error Data
DisconnectData Disconnect Data Connection PortIndex Error Code in case of error Data
AcceptCall Accept a Call PortIndex Status (CONNECTED or NO INCOMING CALL) Voice
GetGsmAudioMode Get the port audio mode PortIndex Audio mode configured Voice
HangupCall Hangs up an existing call PortIndex Error Code in case of error Voice
PlaceCall Place a call PortIndex, DetinationNumber Error Code in case of error Voice
PlayCallAndPlay Place a call and play a wav file PortIndex,DestinationNumber,WavFile,CallDuration,[Timeout] Call Status, Error Code in case of error Voice
PlaceCallAndWaitConnect Place a call and wait until call is connected PortIndex,DestinationNumber,Timeout] Call Status Voice
PlaceShortCall Place a call and disconnect within one second PortIndex,DestinationNumber,Duration(ms) Error Code in case of error Voice
PlayVoice Disconnect Data Connection PortIndex,WavFileToPlay,[PlayEverFlag] Error Code in case of error Voice
RecordVoice Disconnect Data Connection PortIndex,WavFile,[PCMSampleRate16bits] Error Code in case of error Voice
SendDtmf Play a set of DTMF PortIndex,DTMFSequence Error Code in case of error Voice
StopRecording Stop voice recording PortIndex Error Code in case of error Voice
WaitAcceptCallAndRecord Wait Call and record audio file PortIndex,WavFile,[Timeout],[PCM16Flag] Calling Number, Error Code in case of error Voice
WaitAndAcceptCall Wait incoming call and connect it PortIndex, [Timeout] Calling Number,Error Code in case of error Voice
WaitAndRejectCall Wait incoming call and reject it PortIndex, [Timeout], [Reject Cause] Calling Number,Error Code in case of error Voice
WaitCall Wait call PortIndex Error Code in case of error Voice
Retrieved from "https://wiki.ultiroam.com/index.php?title=List_of_R2D2_Commands&oldid=4346"