List of Commands
Jump to navigation
Jump to search
| Command | Input arguments | Returns | Category |
|---|---|---|---|
| BackupCDR | Backup file name | Error Code in the case of error | CDR |
| DeletePortLogs | PortIndex | in the case of error, Error Code | CDR |
| GetCDR | None | CDR file path | CDR |
| GetCdrLine | PortIndex, CdrFileName, LineNumber | CdrLine, in the case of error, Error Code | CDR |
| ResetCDR | None | None | CDR |
| StartPortLog | PortIndex, UniqueId | in the case of error, Error Code | CDR |
| StopPortLog | PortIndex, UniqueId | in the case of error, Error Code | CDR |
| ConnectData | Port index | IP address, in the case of error, Error Code | Data |
| ConnectFtp | Port index, FTP Server IP address of Host Name, [:Peer Port,] User Name, Password [Timeout] | In the case of error, Error Code | Data |
| ConnectHttp | Port index, Proxy IP address or Host Name and Port, User Name, Password, HTTP Version, Maximal Number or Redirections, list of pairs HTTP Header Name - HTTP Header Value | In the case of error, Error Code | Data |
| DisconnectData | Port index | In the case of error, Error Code | Data |
| DisconnectFtp | Port index | In the case of error, Error Code | Data |
| ExecuteHttpMethod | Port index, HTTP Method, URL, User Name, Password, File Path, list of pairs HTTP Header Name - HTTP Header Value | In the case of error, Error Code | Data |
| GetDataParameters | Port index | Data parameters | Data |
| GetDataStatus | Port index | Data Status | Data |
| GetNumberOfPopMessages | Port index, POP Server IP address or Host Name, User Name, Password [SSL flag] | Number of messages in the POP3 mailbox and their total size in bytes | Data |
| ReceiveFtpFile | Port index, Remote File Name, Local File Name, [Timeout] | File saved in specified local file name, in the case of error, Error Code | Data |
| ReceivePopMessage | Port index, POP Server IP address or Host Name, Peer Port, User Name, Password, Message Index, Delete Flag, [Message File Path, SSL flag] | Message saved in specified file, in the case of error, Error Code | Data |
| SendFtpFile | Port index, Local File Path, Remote File Path, [Timeout] | In the case of error, Error Code | Data |
| SendMmsMessage | Port index, MMSC URL, MMS Proxy, SenderName, Visibility, Priority, Subject, RecipientEmail, RecipientNumber, CcEmail, CcNumber, BccEmail, BccNumber, MultipartType, FileType, FilePath, ContentId, ContentType,[ FileType, FilePath, ContentId, ContentType] [ Timeout ] | In the case of error, Error Code | Data |
| SendSmtpFileMessage | Port index, SMTP Server IP Address or Host Name, [:Peer Port], Sender Name, Sender Email Address, Recepient Email Address, CC Email Address, BCC Email Address, Subject, Message File Path, [User Name, Password and SSL flag] | In the case of error, Error Code | Data |
| SendSmtpTextMessage | Port index, SMTP Server IP Address or Host Name, [:Peer Port], Sender Name, Sender Email Address, Recipient Email Address, CC Email Address, BCC Email Address, Subject, Message Text, [User Name, Password and SSL flag] | In the case of error, Error Code | Data |
| SetDataParameters | Port index, APN name, User Name, Password, [Timeout, PDP Header Compression, PDP Data Compression, IP Address, IP Network Mask, Primary DNS, Secondary DNS, Authentication type] | In the case of error, Error Code | Data |
| SetFtpParameters | Port index, [Data Type, FTP Type] | In the case of error, Error Code | Data |
| SpeedTest | Port index, [ServerId] | Public Host, Public IP, Test server, Upload speed, Download speed, Ping. In the case of error, Error Code | Data |
| StreamVideo | Port index, URL | Error Code | Data |
| FxoAcceptAndRecord | Port index, Voice File Name | In the case of error, Error Code | FXO |
| FxoAcceptCall | Port index | status (CONNECTED or NO INCOMING CALL) | FXO |
| FxoCallState | Port index | Call state | FXO |
| FxoHangupCall | Port index | In the case of error, Error Code | FXO |
| FxoPlaceCall | Port index, Called Number | In the case of error, Error Code | FXO |
| FxoPlaceCallAndPlay | Port index, Called Number, Voice File Name, Call Duration | FXO State, in the case of error, Error Code | FXO |
| FxoPlay | Port index, Voice File Name, [Repeat Flag] | In the case of error, Error Code | FXO |
| FxoRecord | Port index, Voice File Name | In the case of error, Error Code | FXO |
| FxoStopRecording | Port index | In the case of error, Error Code | FXO |
| FxoWaitCall | Port index, [Timeout] | In the case of error, Error Code | FXO |
| FxoWaitCallAndRecord | Port index, Voice File Name, [Timeout] | In the case of error, Error Code | FXO |
| ExecuteShellCommand | Command Path, Command Argument | Command Response | General Purpose |
| FirmwareUpdate | Port index, Firmware file name [PortType] | In the case of error, Error Code | General Purpose |
| GetCallInfo | Port index | Call info (Call State, called number, calling number, mode)[2] | General Purpose |
| GetCallState | Port index | Call State[2] (in the case of error: Error Code) | General Purpose |
| GetGeneralTimeout | Timeout, Error Code in the case of error | General Purpose | |
| GetGsmAdapterType | Adapter index | Type of adapter, number of GSM ports | General Purpose |
| GetGsmPortStatus | Port index | Port Status | General Purpose |
| GetGsmRobotApiVersion | None | R2D2 API version | General Purpose |
| GetListOfApiFunctions | [A] | List of supported R2D2 API functions | General Purpose |
| GetModemInfo | Port index | Modem info (Manufacturer, Model type, Firmware version) | General Purpose |
| GetNumberOfGsmAdapters | None | Number of GSM adapters | General Purpose |
| GetNumberOfGsmPorts | None | Number of GSM ports | General Purpose |
| GsmAdapterPowerSupplyOff | Adapter index | In the case of error, Error Code | General Purpose |
| GsmPortPowerSupplyOff | Port index | In the case of error, Error Code | General Purpose |
| SendAtCommand | Port index, AT command | Result of AT command | General Purpose |
| SetGeneralTimeout | Timeout | In the case of error, Error Code | General Purpose |
| StartGsmPort | Port index | In the case of error, Error Code | General Purpose |
| StartPcapTrace | Port index, File path | In the case of error, Error Code | General Purpose |
| StopGsmPort | Port index | In the case of error, Error Code | General Purpose |
| StopPcapTrace | Port index | In the case of error, Error Code | General Purpose
|
| GetGpsData | Port index | GPS data | GPS |
| TurnOffGps | Port index | In the case of error, Error Code | GPS |
| TurnOnGps | Port index | In the case of error, Error Code | GPS |
| AcceptCall | Port index | Status (CONNECTED or NO INCOMING CALL) | GSM Voice Call |
| HangupCall | Port index | In the case of error, Error Code | GSM Voice Call |
| PlaceCall | Port index, Destination number | In the case of error, Error Code | GSM Voice Call |
| PlaceCallAndPlay | Port index, Destination number, Wav file path, Call duration, [Timeout] | Call Status, in the case of error, Error Code | GSM Voice Call |
| PlaceCallAndWaitConnect | Port index, Destination number, [Timeout] | Call status | GSM Voice Call |
| PlaceShortCall | Port index, Destination number, Duration | In the case of error, Error Code | GSM Voice Call |
| PlayVoice | Port index, Wav file path, [repeat flag] | In the case of error, Error Code | GSM Voice Call |
| RecordVoice | Port index, Wav file path, [PCM16 flag] | In the case of error, Error Code | GSM Voice Call |
| SendDtmf | Port index, DTMF sequence | In the case of error, Error Code | GSM Voice Call |
| StopRecording | Port index | In the case of error, Error Code | GSM Voice Call |
| WaitAcceptCallAndRecord | Port index, Wav file path, [Timeout], [PCM16 flag] | Calling number, in the case of error, Error Code | GSM Voice Call |
| WaitAndAcceptCall | Port index, [Timeout] | Calling number, in the case of error, Error Code | GSM Voice Call |
| WaitAndRejectCall | Port index, [Timeout], [RejectCause] | Calling number, in the case of error, Error Code | GSM Voice Call |
| WaitCall | Port index, [Timeout] | In the case of error, Error Code | GSM Voice Call |
| GetAccessTechnology | Port index | Mobile Network Access Technology | Network |
| GetDedicatedChannelInfo | Port index | Dedicated Channel info (status, channel, time slot, timing advance, PWR, RxLevel, quality, mode) | Network |
| GetGsmCurrentOperator | Port index | Operator selection mode, Operator PLMN | Network |
| GetGsmOperatorList | Port index | List of Operators’ PLMN and status | Network |
| GetNeighborCellsInfo | Port index | Neighbor Cells Info (Access Technology, signal level, RSSI, channel, PLMN, BSIC, PSC, RSCP, EcIo) | Network |
| GetNeighborCellsInfoVerbose | Port index | Neighbor Cells Info in GSM module format | Network |
| GetServingCellInfo | Port index | Serving Cell Info (registration status,access technology, signal_level, RSSI, channel, PLMN, LAC/TAC, CellID, NCC, BSIC,PSC, RSCP, Ec/Io) | Network |
| GetServingCellInfoVerbose | Port index | Serving Cell Info in GSM module format | Network |
| GsmRegistrationMode | Port index, [Registration mode] | Command status or the actual Registration mode | Network |
| IMSIAttach | Port index | In the case of error, Error Code | Network |
| IMSIDetach | Port index | In the case of error, Error Code | Network |
| IMSIStatus | Port index | IMSI status (ATTACHED or DETACHED) | Network |
| SelectGsmBand | Port index, Band | In the case of error, Error Code | Network |
| SelectGsmOperator | Port index, Operator selection mode, [Operator PLMN [Access Technology]] | In the case of error, Error Code | Network |
| SetAccessTechnology | Port index, Access Technology | In the case of error, Error Code | Network |
| SetServingCell | Port index, Access Technology, Channel, [Cell Identifier] | In the case of error, Error Code | Network |
| DisablePinLock | Port index, PIN code | In the case of error, Error Code | SIM |
| EnablePinLock | Port index, PIN code | In the case of error, Error Code | SIM |
| EnterPUKCode | Port index, PIN code, PUK code | In the case of error, Error Code | SIM |
| GetIMEI | Port index | GSM port IMEI | SIM |
| GetPinLockStatus | Port index | PIN locking status | SIM |
| GetSimICCID | Port index | SIM card ICCID | SIM |
| GetSimIMSI | Port index | SIM card IMSI | SIM |
| GetSimLocation | Port index | SIM Rack IP address, board/slot | SIM |
| GetSimTMSI | Port index | SIM card TMSI | SIM |
| ReadEccFile | Port index | SIM card EF-ECC file content | SIM |
| ReadKcFile | Port index | SIM card EF-KC file content | SIM |
| ReadLociFile | Port index | SIM card EF-LOCI file content | SIM |
| SetDefaultPinCode | Port index, PIN code | In the case of error, Error Code | SIM |
| SetEccFile | Port index, EF-ECC content | In the case of error, Error Code | SIM |
| SetKcFile | Port index, EF-KC content | In the case of error, Error Code | SIM |
| SetLociFile | Port index, EF-LOCI content | In the case of error, Error Code | SIM |
| SetSimLocation | [SimRackIPAddr, SimRackBoard, SimRackSlot] | [ICCID, IMSI] | In the case of error, Error Code | SIM |
| GsmRoutePrint | None | List of active Sip to GSM port routes | SIP |
| RouteGsmPortToSip | PortIndex, SipDeviceAddress, DestinationNumber, Command (ADD/REMOVE) | In the case of error, Error Code | SIP |
| RouteSipToGsmPort | SipDeviceAddress, PortIndex, Command (ADD/REMOVE) | In the case of error, Error Code | SIP |
| DecodePdu | Port index, PDU buffer | Decoded PDU, in the case of error, Error Code | SMS |
| GetSmsCenter | Port index | SMS Center | SMS |
| SendSmsPdu | Port index, PDU buffer, [SMSC number, Timeout] | In the case of error, Error Code | SMS |
| SendSmsPduAndWaitDelivery | Port index, PDU buffer, [Timeout] | In the case of error, Error Code | SMS |
| SendSmsText | Port index, Destination number, SMS text, [SMSC number, Timeout)] | In the case of error, Error Code | SMS |
| SendSmsTextAndWaitDelivery | Port index, Destination number, SMS text, [Timeout] | In the case of error, Error Code | SMS |
| SetSmsCenter | Port index, SMS Center | In the case of error, Error Code | SMS |
| SimMemoryPurge | Port index | In the case of error, Error Code | SMS |
| StartSmsReceiving | Port index | In the case of error, Error Code | SMS |
| StopSmsReceiving | Port index | In the case of error, Error Code | SMS |
| WaitAndReceiveSms | Port index, [Timeout] | SMS origin number and text, in the case of error, Error Code | SMS |
| CheckCallForwarding | Port index, Forward condition, [Call class] | Call Forwarding status, Forward number | Supplementary Services |
| CheckForwardings | Port index,[ Call class ] | Forward Status, in the case of error, Error Code | Supplementary Services |
| ClearCallForwarding | Port index, Forward condition, [ Call class ] | In the case of error, Error Code | Supplementary Services |
| DisableCallBarring | Port index, PIN code | In the case of error, Error Code | Supplementary Services |
| DisableCallForwarding | Port index, Forward condition, [Call class] | In the case of error, Error Code | Supplementary Services |
| EnableCallBarring | Port index, Lock type, PIN code, [Class] | In the case of error, Error Code | Supplementary Services |
| EnableCallForwarding | Port index, Forward condition, [Call class] | In the case of error, Error Code | Supplementary Services |
| GetCallBarringStatus | Port index | Port Barring status | Supplementary Services |
| GetCallWaiting | Port index | CallWaiting status | Supplementary Services |
| RegisterCallForwarding | Port index, Forward condition, Forward number, No reply delay, [ Call class ] | In the case of error, Error Code | Supplementary Services |
| SetCallWaiting | Port index, Call Waiting flag | In the case of error, Error Code | Supplementary Services |
| SwitchCall | Port index | Call State[2] | Supplementary Services |
| CloseUSSDSession | Port index | In the case of error, Error Code | USSD |
| GetUSSDPush | Port index, [ResetFlag] | USSD data string | USSD |
| GetUSSDResponse | Port index, [Timeout] | USSD response string | USSD |
| GetUSSDTimeout | Port index | USSD Timeout | USSD |
| OpenUSSDSession | Port index, USSD string, charset | In the case of error, Error Code | USSD |
| SendUSSDCommand | Port index, USSD string, charset | In the case of error, Error Code | USSD |
| SetUSSDTimeout | Port index, USSD Timeout | In the case of error, Error Code | USSD |
| ConfigureVolte | Port index, Profile | In the case of error, Error Code | VoLTE |
| GetMbnList | Port index | In the case of error, Error Code | VoLTE |
| GetVolteParameters | PortIndex | In the case of error, Error Code | VoLTE |
| GetVolteStatus | PortIndex | In the case of error, Error Code | VoLTE |
| SetVolteParameters | PortIndex, VolteMode, [ APN, UserName, Password, AuthType, PDPType, MbnProfile ] | In the case of error, Error Code | VoLTE |
| UploadMbnFile | Port index, MbnFile | In the case of error, Error Code | VoLTE |