Microsip Api Documentation |work| [TESTED - 2025]

You can pass real-time call metadata to your scripts using MicroSIP's native variables: Description Example Output %number% The remote party's phone number or SIP user ID +15550199 %name% The Caller ID name (if provided by the SIP header) John Doe %account% The local SIP account alias processing the call Office_Line_1 Integration Examples Example A: Open a CRM Contact Page on Incoming Call

// Terminate the SIP session sip_hangup();

However, MicroSIP does have two automation interfaces:

ini manually. * "cmdCallStart" - runs specified command when connection established. Caller ID passed as parameter. * "cmdCallEnd" MicroSIP online help microsip api documentation

: Injects custom text or headers into the outbound SIP INVITE request (highly useful for custom routing rules on your PBX).

On Error Resume Next Set dde = CreateObject("DDEClient") dde.Application = "MicroSIP" dde.Topic = "control" MsgBox dde.Execute("[Status]") If Err.Number <> 0 Then MsgBox "MicroSIP not running or DDE failed."

Through source code analysis (MicroSIP is GPL-licensed on GitHub), additional behaviors emerge: You can pass real-time call metadata to your

MicroSip is designed to be a single-instance app. Sending a new command usually interacts with the already running process rather than opening a second window.

is a lightweight, open-source Windows SIP softphone renowned for its minimal resource usage (under 5MB of RAM) and exceptional audio quality. However, its true hidden power lies not in its GUI, but in its Command Line Interface (CLI) and Windows Messaging API .

Trigger an action when the call transitions to an active state. * "cmdCallEnd" MicroSIP online help : Injects custom

This documentation provides a comprehensive guide to controlling, automating, and integrating MicroSIP into your Helpdesk, CRM, or custom application. 1. Command-Line Interface (CLI) API

MicroSIP.exe transfer:sip:5551234@pbx.domain.com

| Parameter | Description | Example | |-----------|-------------|---------| | --dn | Display Name | --dn "John Doe" | | --user | SIP Username (auth ID) | --user 101 | | --domain | SIP Domain / Registrar | --domain sip.mycompany.com | | --password | SIP Password (plain text, be cautious) | --password secret123 | | --proxy | Outbound proxy (optional) | --proxy 192.168.1.100:5060 | | --stun | STUN server for NAT | --stun stun.l.google.com:19302 | | --call | Immediately dial a number after launch | --call "5551234" | | --autoanswer | Automatically answer incoming calls (0/1) | --autoanswer 1 | | --dialplan | Prepend digits for external calls (e.g., 9 for outside line) | --dialplan "9,<.*>" | | --show | Window state: normal , minimized , hidden | --show hidden | | --debug | Enable SIP trace to file | --debug C:\logs\sip.log | | --log | Log calls to CSV | --log C:\logs\calls.csv | | --setvolume | Initial speaker volume (0–100) | --setvolume 80 | | --micvolume | Microphone volume | --micvolume 90 |