INFO

SwyxIt! Web Extension Variables (kb3694)

The information in this article applies to:

  • SwyxWare v6.12
  • SwyxIt! v6.12

[ Summary | Information ]


Summary

The SwyxIt! Web Extension control offers the possibility to work with variables in Website URLs and/or in the Website HTML code. These variables are replaced with their values during the website load process.

Therefore you can create specific Web applications which work with these variables. For example you can create an application which resolves the phone number of incoming calls through an internet telephone directory (for details see below). Such information can then be displayed directly on the SwyxIt! Skin, or you can use it to start further inquiries.


Information

Example 1 - Variables in the URL:

The following URL makes it possible to resolve the calling party number of incoming calls through the internet telephone directory "www.dastelefonbuch.de".

http://www.dastelefonbuch.de/?kw=%SelLinePeernumberPublicFormat%&cmd=search

Here the variable "%SelLinePeernumberPublicFormat%" is used which contains the calling party number of the last (or still active) call in a non-canonical format (see details below).

Example 2 - Variables embedded in the HTML code:

Create a new HTML file and insert the following HTML code:

<html>
<head>
<title>SwyxIt! Web Extensions - Variables Test Page</title>
</head>
<body>
<font face="arial">
<b>Information</b><br>
Username: %OwnName%<br>
SwyxServer: %ActiveServerName%<br><br>
<b>Your last call:</b><br>
Calling party number: %SelLinePeernumberPublicFormat%<br>
Displayed Name: %SelLinePeername%<br><br>
<b>Windows Enviroment Variables:</b><br>
Windows Directory: %WINDIR%<br>
Program Files Directory: %PROGRAMFILES%<br>
</font>
</body>
</html>


Save the file and open it in the SwyxIt! Web Extension Control.

Supported variables:

Please note: The variables are replaced case insensitive.

%SelLinePeernumber% is the phone number of the other party (for inbound and outbound calls) on the selected line.

%RelatedLinePeernumber% is the phone number of the other party (for inbound and outbound calls) on the line that is linked to the Web Extension.

%SelLinePeernumberPublicFormat% is the phone number of the other party (for inbound and outbound calls) in non-canonical format without public access prefix on the selected line (the settings from the user’s location willbe used).

Example:
Public Line Access Prefix: 0
Long Distance Prefix: 0
International Prefix: 00
Area Code: 231
Country Code: 49
 

 SelLinePeernumber  SelLinePeernumberPublicFormat
 0003320123456  003320123456
 0004940123456  040123456
 00049231123456  0231123456
 0040123456  040123456
 00231123456  0231123456
 0123456  0231123456 
 200  200


%RelatedLinePeernumberPublicFormat% is similar to %SelLinePeernumberPublicFormat% but retrieves the value from the line that is linked to the Web Extension.

%SelLinePeername% is the display name of the other party (for inbound and outbound calls) on the selected line.

%RelatedLinePeername% is similar to %SelLinePeername% but retrieves the value from the line that is linked to the Web Extension.

%SelLinePeeraddress% contains the
  - %SelLinePeername% and the %SelLinePeernumber% when both details are known
  - %SelLinePeername% when only the name is known
  - %SelLinePeernumber% when only the number is known

%RelatedLinePeeraddress% is similar to %SelLinePeeraddress% but retrieves the value from the line that is linked to the Web Extension.

%SelLineCallednumber% is the own called extension or group extension for inbound calls. This parameter is empty for outbound calls.

%RelatedLineCallednumber% is similar to %SelLineCallednumber% but retrieves the value from the line that is linked to the Web Extension.

%SelLineCalledname% is the own called name or group name for inbound calls. This parameter is empty for outbound calls.

%RelatedLineCalledname% is similar to %SelLineCalledname% but retrieves the value from the line that is linked to the Web Extension.

%SelLineCalledaddress% contains the
  - %SelLineCalledname% and the %SelLineCallednumber% when both details are known
  - %SelLineCalledname% when only the name is known
  - %SelLineCallednumber% when only the number is known

%RelatedLineCalledaddress% is similar to %SelLineCalledaddress% but retrieves the value from the line that is linked to the Web Extension.

%SelLineCallID% is the call id (CDR id) of the current / previous call on the selected line.

%RelatedLineCallID% is the call id (CDR id) of the current / previous call on the line that is linked to the Web Extension.

%SelLineDisconnectReason% is the disconnect reason of the current / previous call on the selected line. Possible disconnect reasons are:

  0 normal disconnect
  1 peer was busy
  2 peer rejected call
  3 call was cancelled
  4 call was transferred
  6 peer did not pick up, timeout
  7 call was already picked up from other phone
  9 invalid number was dialed
10 destination is unreachable
12 call routing failed, possible script error (script of peer)
13 permission for call was denied due to call restrictions (e.g. no long distance call allowed)
14 no line available (within ISDN network)
15 no gateway channel available
16 the number of the called party has changed
17 the device type of the called party is incompatible
18 wrong phone number format, e.g. bad character

%RelatedLineDisconnectReason% is the disconnect reason of the current / previous call on the line that is linked to the Web Extension.

%OwnName% is the own SwyxWare name as displayed in the SwyxIt! display

%ActiveServerName% is the name of the active SwyxServer as displayed in the SwyxIt! display

Windows environment variables are supported as well (e.g. %PROGRAMFILES%).

 


Comment

Comment on this article



If we have any follow-up questions, where can we contact you?

E-Mail Address (optional)


Note

This feedback form can't be used for support requests. Those requests must be directed to your Swyx reseller or distributor.