Api Documentation | Microsip
import subprocess import os def hangup_microsip(): microsip_path = r"C:\Program Files\MicroSIP\microsip.exe" if os.path.exists(microsip_path): subprocess.Popen([microsip_path, "-hangup"]) hangup_microsip() Use code with caution. 2. URL Protocol Handler Integration (click-to-call)
The resources outlined here represent the fundamental layers of the "MicroSIP API." Developers will find that for basic tasks, the command-line interface is the tool of choice. For large-scale deployment, the auto-configuration scripts are essential. For those building advanced management tools, understanding the encryption and XML APIs is critical.
MicroSIP allows you to link specific SIP events to command-line actions. You can configure these in the microsip.ini file located in the application directory. Key Event Hooks
MicroSIP registers the sip: protocol handler in Windows. You can run this directly from a command prompt, a batch file, or a link on a webpage to initiate a call. sip:username@domain or sip:number@sip_proxy Example Command: start sip:100@192.168.1.10 3. microsip.ini Event Hooks microsip api documentation
A developer or administrator can mix and match these resources to achieve virtually any goal, from a simple click-to-dial application for a single user to a centrally managed, white-labeled telephony platform for a large enterprise.
Log the start time of the conversation or open a ticket. Format: cmdCallAnswer=C:\path\to\your\script.bat cmdCallStart
microsip.exe quit
When a user clicks these links, Windows passes the phone number directly to the running MicroSip instance to initiate dialing immediately. 4. Code Examples C# Example: Initiating a Call via CLI
[Codecs] PCMU=8000 PCMA=8000 G722=8000 Opus=48000
You can start MicroSIP.exe with specific arguments to customize its behavior, which is ideal for integration with CRM systems or automated click-to-dial tools. You can configure these in the microsip
that provides a Pythonic way to interact with MicroSIP, though it is a community-maintained tool.
There is no official SDK or native library for embedding the softphone engine directly into other software beyond using its source code. 3. Community and Third-Party Resources
: Start MicroSIP directly in the Windows system tray without opening the main window on the desktop. -exit : Close the running instance of MicroSIP completely. Example Implementation (Python): The dwData field identifies the command
When you look at a MicroSIP.ini file, you won't find SIP passwords in plain text. MicroSIP uses a dedicated cryptography utility ( CCrypto ) that wraps the Windows Cryptography API to ensure that sensitive data is stored securely.
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.
