Action URL User Guide
Grandstream Networks, Inc.
ActionURL Module User Guide
ActionURL Module User Guide
Page 1 of 9
ActionURL Module User Guide
Index
INTRODUCTION ........................................................................................ 3
OVERVIEW OF FUNCTIONS ................................................................ ..... 4
SUPPORTED EVENTS ......................................................................................................................... 4
SUPPORTED DYNAMIC VARIABLES .................................................................................................. 4
ACTIONURL FORMAT ............................................................................... 6
EVENT NOTIFICATION ......................................................................................................................... 7
USING ACTIONURL MODULE .................................................................. 8
ActionURL Module User Guide
Page 2 of 9
Table of Figures
ActionURL Module User Guide
Figure 1: ActionURL Example on Phone Web UI ......................................................................................... 6
Figure 2: ActionURL Example Sending to SIP server ................................................................................... 7
Figure 3: Multiple ActionURL......................................................................................................................... 8
Figure 4: Multiple ActionURL Sending to SIP Server .................................................................................... 9
ActionURL Module User Guide
Page 3 of 9
INTRODUCTION
ActionURL module is used to set the URL for various kinds of phone events on phone web GUI, and when
the corresponding event occurs on the phone, phone will send the configured URL to SIP server. The
dynamic variables in the URL will be replaced by the actual values of the phone before sending to SIP
server, in order to achieve the purpose of events notification. Users need to follow the specified variable
format to create URL for phones, in order to replace the dynamic variables successfully.
This user guide aims to help users to use ActionURL module on GXV3240/3275 build 1.0.3.24 or higher
version.
ActionURL Module User Guide
Page 4 of 9
OVERVIEW OF FUNCTIONS
$phone_ip
The IP address of the phone
$mac
The MAC address of the phone
$product
The product name of the phone
To use ActionURL module, users need to know the supported events in this module, and also added the
dynamic variables of the supported events on phone web GUI. The dynamic variables of the supported
event will be replaced by actual values of the phone, in order to notify the event to SIP server.
SUPPORTED EVENTS
Incoming Call
Outgoing Call
Establish Call
Terminate Call
Off Hook
On Hook
Missed Call
DND On
DND Off
Call Forwarding On
Call Forwarding Off
Hold Call
Resume Call
Syslog On
Syslog Off
Booting Completed
Blind Transferring
Attended Transferring
Registration
Sign Off
SUPPORTED DYNAMIC VARIABLES
ActionURL Module User Guide
Page 5 of 9
$program_version
The software version of the phone
$hardware_version
The hardware version of the phone
$language
The display language of the phone
$local
The called number on the phone
$display_local
The display name of the called number on the phone
$remote
The call number on the remote phone
$display_remote
The display name of the call number on the remote phone
$call-id
The message label in the same session group. This is the only thing to
distinguish if the session messages are in the same group, and the requests
and the responses should contain the same call id.
$active_user
The account number which is during a call on the phone
$active_host
The SIP server of the account number which is during a call on the phone
$duration
Talk time (Unit: seconds)
$calldirection
Direction of the call, which represents the phone is calling party or called party
ActionURL Module User Guide
Page 6 of 9
ACTIONURL FORMAT
Users need to go to web GUI -> Maintenance -> Event Notify to add the ActionURL with the dynamic
variables. Here are the standards of ActionURL:
1. The IP address of the SIP server needs to be added at the beginning of the ActionURL, and separate
the dynamic variables with a “/”.
2. The dynamic variables need to have a “$” at the beginning, for example:
local=$local
call-id=$call-id
3. If users need to add multiple dynamic variables in the same event, users could use “&” to connect with
different dynamic variables. You can see the example of ActionURL in the figure below:
Figure 1: ActionURL Example on Phone Web UI
ActionURL Module User Guide
Page 7 of 9
EVENT NOTIFICATION
When user finishes setting ActionURL on phone web GUI, and the specified phone event occurs on the
phone, phone will send the ActionURL to the specified SIP server. The dynamic variables in the ActionURL
will be replaced by the actual values. If users observe the traffic, phone will send HTTP message with the
ActionURL with the actual values to SIP server, as the figure shows below, the ActionURL is to notify SIP
server with call ID:
Figure 2: ActionURL Example Sending to SIP server
ActionURL Module User Guide
Page 8 of 9
USING ACTIONURL MODULE
Here is an example shows the full steps how to use ActionURL on a GXV3240:
1. Go to GXV3240 web GUI-> Maintenance -> Event Notify, add the ActionURL to specified phone
events following the standards. The figure shows an example of multiple ActionURL in different phone
events:
ActionURL:
Incoming Call: 192.168.40.207/mac=$mac&local=$local
Outgoing Call: 192.168.40.207/remote=$remote&phone_ip=$phone_ip
On Unhold: 192.168.40.207/call-id=$call-id&program_version=$program_version
Figure 3: Multiple ActionURL
2. Make an incoming call, an outgoing call, and unhold the call for the phone, capture the traffic, phone
will send the ActionURL with actual values to SIP server, in order to achieve to notify phone events, as
the figure shows below. From top to bottom, the phone events included in the HTTP messages are:
Outgoing Call, Incoming Call and the On Hold.
ActionURL Module User Guide
Page 9 of 9
Figure 4: Multiple ActionURL Sending to SIP Server
Loading...