Action URL Variables

Owned by Kelli Higdon
Last updated: Feb 28, 2024
2 min read

An HTTP GET request may contain variable name and variable value, separated by "=". Each variable value starts with$ in the query part of the URL. The valid URL format is: http(s)://IP address of server/help.xml?variable name=$variable value. Variable name can be customized by users, while the variable value is pre-defined. For example, a URL http://192.168.0.251/help.xml?mac=$mac is specified for the event Mute, $mac will be dynamically replaced with the MAC address of the Sangoma phone when the Sangoma phone mutes a call. 

 

Variable

Description

$mac

MAC address of the Sangoma Phone

$ip

The current IP address of the Sangoma Phone

$model

Phone model

$firmware

Phone firmware version

$active_url

The SIP URI of the current account when the Sangoma Phone places a call, receives an incoming call or establishes a call.

$active_user

The user part of the SIP URI for the current account when the Sangoma Phone places a call,receives an incoming call or establishes a call.

$active_host

The host part of the SIP URI for the current account when the Sangoma Phone places a call, receives an incoming call or establishes a call.

$local

The SIP URI of the caller when the Sangoma Phone places a call.
The SIP URI of the callee when the Sangoma Phone receives an incoming call.

$remote

The SIP URI of the callee when the Sangoma Phone places a call.
The SIP URI of the caller when the Sangoma Phone receives an incoming call.

$display_local

The display name of the caller when the Sangoma Phone places a call.
The display name of the callee when the Sangoma Phone receives an incoming call.

$display_remote

The display name of the callee when the Sangoma Phone places a call.
The display name of the caller when the Sangoma Phone receives an incoming call. 

$call_id

The caller ID of the active call. 

Return to Documentation Home I Return to Sangoma Support