Features/Action URL
From Snom User Wiki
Contents |
History
FW Versions: 
Enhanced Support | 
| 
| 
- Very basic Action URL support was introduced in Firmware Version 3.X -> No parameter support
- Enhanced functionality was implemented in Firmware Version >= 4.0 -> support of real time parameters: $local, $remote, $call-id, and $active_url
Phone Models: 
Action URL´s w/o parameters | 
| 
| 
Description
Action URLs are basically HTTP GET Requests. They allow you to set a status on the server or retrieve Minibrowser applications by pressing a particular key on the phone.
Usage
The Action URL consists of a normal HTTP-Url (e.g. http://some.server.com/path/to/app). Additionally you can extend the URL and give some parameters to the application. You can dynamically pass all values that are visible on the 'Settings' page:
- e.g. http://some.server.com/path/to/app.php?mac=$mac&user=$user_name1
The variable $mac will be dynamically replaced with the MAC-Address of the phone and $user_name1 will be replaced with the username of the first identity. Note that you have to put a dollar sign ($) in front of the variable.
Alongside to the shown variables on the 'Settings' page there are also the reserved variables $local, $remote and $call-id, which will be replaced with the local URI, the remote URI and the Call-ID for the current call.
Note: Private data, such as passwords, will be replaced with an empty string.
See the Examples section below to get a further understanding.
Applications
Figure 1 shows the 'Function Keys' page which is accessible through the left menu of the web interface of your phone. Here you can change the behaviour of the function keys on the phone. This is the main page we will refer to in the following screenshots and descriptions. It is accessible through the web interface of your phone.
A simple example:
Let's suppose we have a Call Center. We have several agents, some are calling, some are busy preparing the call notes, some are out for lunch. Now an agent who was busy before is available for a call again, obviously he/she has to tell the call distributor about it. By provisioning a function key with such an option we can make the operators' life easier (see also the Mass deployment information). That's how it's done:
Go to the 'Function Keys' page on the web interface and choose a function key to use. Select 'Action URL' from the 'Type' fields (see Figure 2).
Now type in the URL of your application server that needs to know about the current status of the agent.
- e.g. http://192.168.0.1/free.php?number=$user_name1
Explanation: The phone will place a HTTP GET to http://192.168.0.1/free.php give the user name of the first identity in the parameter number. This can then be catched in the application and update the status of an agent.
Minibrowser
The Action URLs can also retrieve Minibrowser applications. Further details can be found at the Minibrowser XML Objects page.
Examples
Special Mailbox number on the 'Retrieve' button
--Evgenij tovba 13:44, 24 April 2006 (CEST)
Similar to modern cellular phones the 'Retrieve' Button takes the place of the Mailbox key, which is used to go to the mailbox of the account. Normally you don't have to worry about the number to dial to achieve this, since it is implemented in the MWI message from the server. But in some cases you want to use a special number on the retrieve key. That's how it's done:
Go to the 'Function Keys' page on the web-interface of your phone and select 'Speed Dial' as the type in the 'Retrieve' row, (see Figure 4).
In the 'Number' field, right next to the 'Type' field, enter the number of your Mailbox. Please ask your operator for the proper number. Usually it is your own number, or a star code, e.g. *99.
Note: The call will be made in the currently selected context, i.e. you have to manually select the identity you wish to use first. Also keep the active dial plans in mind.
... And Action! The 'Action URL Settings'
--Evgenij tovba 13:44, 24 April 2006 (CEST)
As you can see in Figure 6, we are using the 'Action URL Settings' to tell a server that the phone is in DND mode.
- e.g. http://server.com/dnd.php?mac=$mac
Explanation: We tell the dnd.php application that the phone with the MAC address $mac is in DND mode. The server could for example update a presence setting in a database.
Imagine another scenario: You are listening to your favourite MP3s at work and want to stop the player automatically when you have an incoming call. Or: You want to be alerted on your cell phone or your favourite Instant Messaging client, when you have missed a call. As an Administrator: Keep an eye of the phones in your company and make sure, all phones are set up. And so on...
