When MicroSIP executes your script (via microsip.ini triggers), it sends the caller ID as the first argument ( %1 in Windows batch files or sys.argv[1] in Python).
For deep desktop integration, MicroSIP supports communication via the Windows Messaging API ( Win32 ). This allows a parent application to programmatically send instructions to MicroSIP and receive status updates. Sending Commands to MicroSIP
Unlike modern VoIP clients (such as Zoiper or Bria), MicroSIP does not have a publicly documented REST API or a standard WebSocket interface. However, it offers powerful automation capabilities through , INI Configuration Files , and Windows Message Handling .
microsip.exe sips:username@secure-provider.com Call Control and Window Arguments
This is the more powerful interface. Any Windows application can send a WM_COPYDATA message to MicroSIP’s main window (class "MicroSIP" ). The dwData field identifies the command, and lpData contains a UTF-8 string with parameters. microsip api documentation
A Python script can act as a bridge:
For developers looking to programmatically manipulate contact lists or analyze call history, understanding this XML structure is essential.
When automating multiple calls sequentially, insert a delay (cooldown period) between the -hangup command and the next -dial command to allow the SIP server to clear the session state.
Defining actions that run upon specific call events. 2. Command Line Parameters When MicroSIP executes your script (via microsip
Execute scripts on call start, end, answer, or incoming status. Full control via microsip.ini for portable deployments. Source Access Open source (C/C++) for deep custom modifications. MicroSIP online help
cmdIncomingCall=node "C:\ProgramData\MicroSIP\microsip-bridge.js" --event=ringing cmdCallAnswer=node "C:\ProgramData\MicroSIP\microsip-bridge.js" --event=answered cmdCallEnd=node "C:\ProgramData\MicroSIP\microsip-bridge.js" --event=ended Use code with caution. 5. Automated Deployment & Secure Provisioning API
MicroSIP does not provide a formal REST or web API. Instead, it offers a robust Command Line Interface (CLI) external event triggers
You can pass arguments to the MicroSIP.exe executable to trigger actions instantly. This is useful for building dialers in other software. Basic Launch Parameters Sending Commands to MicroSIP Unlike modern VoIP clients
Runs a command when the user answers an incoming call. Caller ID is passed as a parameter. Example Integration (CRM Popup)
To open a web-based CRM search page automatically when a phone rings, paste the following into the field:
Once enabled, you can insert standard hyperlinks into your internal web applications or CRM dashboards:
that allow other applications to control the softphone or react to incoming calls. 🔌 Controlling MicroSIP (Outbound) You can control an active MicroSIP instance by running microsip.exe
Runs a command when a call connection is established. Caller ID is passed as a parameter.