Microsip Api - Documentation
Launching MicroSIP.exe with parameters to take immediate action.
To programmatically initiate actions from an external application (like a CRM or browser extension), you can execute MicroSIP.exe via the command line or target it using the standard sip: protocol handler. Outbound Dialing (CLI)
Unlike modern VoIP softphones (like Zoiper or Linphone), MicroSIP does not have a built-in HTTP/REST API or a WebSocket interface. Instead, it relies on and Windows Message Hooks .
: Fires immediately when an inbound SIP INVITE hits the softphone (while the phone is ringing). Macro Token ( %1 ) : Passes the raw incoming Caller ID string. microsip api documentation
MicroSip can be configured to send notifications back to your application's window. Common Action Commands: action=ready : Checks if MicroSip is active. action=call&number=123 : Starts a call. action=hangup : Ends the session. Best Practices for Implementation
For developers looking to deeply customize or extend MicroSIP, its source code provides an "API" in the traditional sense. The application is written in C/C++ and structured around the . This section is for those considering forking the project or understanding its internal operations.
Official support for integration issues is limited; most troubleshooting is handled through community forums or online help pages. Summary of Documentation Features Documented Capability Command Line Basic call control and application launching. Event Triggers Launching MicroSIP
This article serves as the for MicroSIP API documentation. You will learn the syntax, real-world examples, and integration patterns.
[Account] Account=name@example.com ; The SIP username/domain Domain=example.com ; SIP Domain (optional) Proxy=sip:proxy.example.com ; Outbound proxy (optional) AuthID=1001 ; Authentication ID (if different from username) Password=secret123 ; Plain text password DisplayName=John Doe ; Caller ID Name
MicroSIP.exe [command] [parameter]
For advanced requirements where command-line control is insufficient, you can interact with the core softphone at the binary level. MicroSIP online help
It is also possible to force MicroSIP to load an override.ini from the same directory; any settings in this file will take precedence over the primary configuration and the user's local settings, a feature useful for enterprise deployments.
For developers, "MicroSIP API" usually refers to one of three things: Command Line Arguments : You can control MicroSIP via the CLI. For example, using /i:microsip.ini to specify configuration files. PJSIP Stack Instead, it relies on and Windows Message Hooks