Microsip — Api Documentation ((hot))
Complete MicroSIP API Documentation: Integration and Automation Guide
MicroSIP is a highly popular, lightweight, and open-source SIP softphone designed for Windows. While it does not feature a traditional web-based REST API, it provides a robust set of command-line arguments and configuration triggers in the microsip.ini file. These features serve as its functional API, allowing developers to automate dialing, manage active calls, and integrate the softphone with external CRM platforms, helpdesk software, or custom scripts.
This comprehensive guide serves as the unofficial documentation for programmatic interaction with MicroSIP. 1. Command-Line API (Controlling MicroSIP)
You can control a running instance of MicroSIP or initialize actions by executing the microsip.exe binary with specific parameters. This is highly effective for "Click-to-Call" features in web browsers or desktop applications. Outbound Calls
To initiate a voice call automatically, pass the target phone number or SIP URI directly as an argument. Syntax: microsip.exe [number_or_uri] Example: microsip.exe 101 Example: microsip.exe sip:user@://provider.com Global Call Controls
You can manage existing calls by calling the executable with specific control flags:
Answer a Call: microsip.exe /answer (answers the current incoming call)
Hang Up All Calls: microsip.exe /hangupall (terminates all active sessions) Application State
Start Minimized: microsip.exe /minimized (loads the app directly to the system tray)
Exit Application: microsip.exe /exit (gracefully closes the running MicroSIP process) Configuration Profiles
Custom Ini File: microsip.exe /i:custom_config.ini (runs the application using a specific configuration file instead of the default one) 2. Event-Driven Triggers (microsip.ini API) microsip api documentation
MicroSIP can execute local scripts or third-party executable files when specific call events occur. This effectively allows bi-directional communication between MicroSIP and your local applications (like populating a CRM screen when a call arrives).
To configure these, open your microsip.ini file (found in the installation directory or in %appdata%\MicroSIP\) and add or modify the following keys under the [Settings] block: Key Event Triggers
Every time these triggers fire, MicroSIP will pass the Caller ID as a plain text string parameter to your script. cmdIncomingCall Event: An incoming call rings on the softphone.
Use Case: Trigger a CRM database lookup to show who is calling before answering. Format: cmdIncomingCall=C:\path\to\your\script.bat cmdCallAnswer Event: The user answers the incoming call.
Use Case: Log the start time of the conversation or open a ticket. Format: cmdCallAnswer=C:\path\to\your\script.bat cmdCallStart
Event: The media connection is successfully established (outbound or inbound). Use Case: Start tracking call duration. Format: cmdCallStart=C:\path\to\your\script.bat cmdCallEnd Event: The call is disconnected or hung up.
Use Case: Push call logs, handle automated post-call cleanup, or stop a timer. Format: cmdCallEnd=C:\path\to\your\script.bat 3. Best Practices for MicroSIP Integration
To ensure smooth operation when building an integration layer for MicroSIP, developers should adhere to the following architectural patterns: Handling Parameters in Scripts
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). Batch Example:
@echo off echo The caller ID is %1 python c:\scripts\crm_lookup.py --number=%1 Use code with caution. Managing the Running Process Blind transfer current call to 1002
MicroSIP
Ensure your external scripts do not lock up or create infinite loops. Because MicroSIP executes these scripts synchronously, a hung script could cause the softphone UI to freeze. Always run heavy operations asynchronously or in the background from your initial trigger script. Next Steps for Your Integration
To help you build out a tailored communication stack, let me know:
What CRM or database are you trying to connect with MicroSIP?
Do you prefer writing your automation scripts in Python, Node.js, or Windows Batch?
Are you looking to pass data beyond just the Caller ID (like call duration or SIP headers)?
I can provide a ready-to-use template script based on your environment.
Finding a single "official" API documentation page for can be tricky because it is a lightweight, open-source project that doesn't have a massive developer portal. Instead, MicroSIP's "API" is usually handled through Command Line Arguments or by interacting with its Source Code
Depending on what you are trying to do, here are the most solid resources and methods for integration: 1. Command Line API (Most Common)
For most desktop integrations (like clicking a number in a CRM to dial), you use command line arguments. MicroSIP supports standard SIP URI schemes and specific flags: Basic Dialing microsip.exe sip:number@domain microsip.exe number microsip.exe -hangup microsip.exe -answer Minimize/Restore microsip.exe -minimize 2. Custom Builds & Scripting
If you need deeper programmatic control, MicroSIP is highly customizable: Custom Build Request : The official site offers a Custom Build Request Form Python with pywin32
if you need a version of the software with specific hardcoded behaviors or branding. Direct Database Access : For advanced users, there is a community-driven Microsip-API on GitHub
that serves as an endpoint server with direct access to the MicroSIP FirebirdSQL database. 3. Source Code Exploration Since MicroSIP is based on the PJSIP stack , its core logic follows PJSIP's standards. Source Code : You can download the incremental archives from the MicroSIP Source Page to see how it handles calls internally. Help & Configuration MicroSIP Online Help
provides a breakdown of settings and INI file configurations, which is often where you'll find "hidden" logic for how the app behaves during calls. 4. Third-Party Wrappers Python Wrapper : There is a microsip-api package on PyPI
that provides a Pythonic way to interact with MicroSIP, though it is a community-maintained tool.
Are you looking to trigger calls from a web app, or are you trying to build a custom version of the softphone? MicroSIP online help
Pattern 3: Call Recording Trigger
- DDE command
[Status]returns "ringing", "connected", "idle". - When state changes to "connected", start audio recording (e.g., using FFmpeg from virtual audio cable).
Blind transfer current call to 1002
MicroSIP.exe transfer 1002
6. Audio Device Control
- Mute/unmute microphone during a call.
- Adjust speaker/microphone volume.
- Switch between audio devices (headset, speakerphone).
4. Undocumented or Implicit Behaviors
Through source code analysis (MicroSIP is GPL-licensed on GitHub), additional behaviors emerge:
- Multiple calls: The
ACTIVECALLcommand only returns the first active call. No method exists to enumerate multiple held calls. - Account switching: No API command to switch between configured SIP accounts.
- Registration status: Cannot query if SIP registrar is reachable.
- Log retrieval: No API to fetch call logs or debug logs.
4. Advanced Control (Windows API)
If you need to programmatically perform actions like Hangup, Hold, or Answer while the app is running (without user input), you must use Windows API calls.
Note: This requires a programming language that supports Win32 API (C++, C#, Python with pywin32, AutoIt, etc.).