SipXphone Web UI

From SIPfoundry sipXecs IP PBX, The Open Source SIP PBX for Linux - Calivia

Jump to: navigation, search

Contents

Introduction to the sipXphone Web UI

This page describes how to configure sipXphone using its Web UI. Please refer to sipXphone Installation to learn about how to install sipXphone. Please note that before being able to access the phone's built-in Web server, it has to be enabled using the phone top UI.

For further information about sipXphone features and functionality refer to


sipXphone Configuration Files

Using sipXphone's Web UI allows the configuration of all aspects of the phone without a need to ever access or modify any configuration files directly. However, it can be helpful to understand the various parameters defined in these configuration files as the Web UI makes frequent reference to these parameters.

Note: In order to specify certain parameters the field Additional Parameters under Administration - Phone Configuration has to be used (this requires specific knowledge about such parameters, their values and meaning. Refer to configuration files).

sipXphone Web UI Home Page

Image:SipXphone-Web-Home.jpg


The main navigation bar of the sipXphone Web UI consists of the following tabs:

  

Home:

The Home page of sipXphone allows to dial a number by URL as well as upload a ringtone file of choice.

  

Applications:

The Applications tab allows to manage Java applications that can be uploaded to sipXphone. Currently there are none such applications available from SIPfoundry and also there is no documentation available on how to design such applications. We are planning to add this as soon as possible but for now we suggest to ignore this tab.

  

SpeedDial:

The SpeedDial tab allows to define and use speed dial buttons with your sipXphone. There are a virtually unlimited number of speed dial numbers allowed. Refer to How to store speed dial numbers for further details.

  

Preferences:

The Preferences tab is very inportant as it allows the setup of device and user lines as well as set call handling preferences for every one of these lines.

  

Administration:

The Administration tab includes all the different administrative tasks necessary to configure and operate sipXphone. In particular, it includes User Maintenance, Change Password, Phone Configuration, File Upload, as well as SIP Log.

The pages Home, Applications, and SpeedDial are fairly straight forward and the Web UI itself provides a lot of additional information. We therefore do not provide additional instructions for these tabs here. The pages Preferences and Administration, however, are rather complex and we will get into more details below.

The Administration Tab

1. User Maintenance

Because a single sipXphone can be configured with several user lines in case the phone is used by different users, it is possible to define several individual user accounts so that every user has an individual login into the Web-based UI. This feature seems rather overkill for a softphone and we therefore recommend to ignore this tab.

2. Change Password

The Change Password tab allows you to change the admin password.

3. Phone Configuration

  

Call Addressing:

Refer to How to define a dial plan. Note: A digit map is followed by a SIP address specific to this digit map. This allows calls to be routed to different destinations (user agents or more likely proxy servers) based on rules defined in the digit map. A dial plan then is a set of digit maps combined with their respective SIP addresses. Note: If a SIP Proxy or Directory server is used then dial plan information is configured in the server and not the individual phones.

  

Network Settings

The parameter PHONESET_RTP_PORT_START allows the definition of a start port for RTP sessions (default is 8766). This can be useful if in a simple NAT traversal case a range of ports is opened on the NAT/Firewall that should be used for RTP traffic. The parameter PHONESET_EXTERNAL_IP_ADDRESS, which can be used for simple NAT traversal to define the external IP address of the NAT Router that should be inserted into the sender ID for outgoing SIP packets. For a definition of how to setup messaging waiting refer to How to enable voice mail message indication

  

SIP Servers

Refer to Configuring phones for SIP environments. Note: In a normal installation the SIP Proxy and Redirect Server is where you want the phone to route outgoing calls. The second field Proxy Server should not be used unless in special cases where ALL traffic must pass through a proxy server before it even reaches the directory server (I.e. a small branch office using a SIP proxy firewall to reach the corporate directory server at HQ).

  

Do Not Disturb

This parameter specifies how calls will be handled when the user has the Do Not Distrurb function set to on (PHONESET_DND set to ENABLE). For more details refer to How to define incoming call handling

  

Phone Display

sipXphone offers great flexibility in terms of what to display on the phone's screen. The only parameter exposed in the Web UI is PHONESET_LOGO_URL; additional parameters can be defined below under Additional Parameters. For more information refer to How to change the phone's home screen display

  

Additional Parameters

Parameters that are defined but not present in the Web UI can be added into the field for Additional Parameters. Please refer to sipXphone Configuration Files for a definition of all possible parameters.

To define a ring down address refer to How to setup a ring down address. For a definition on how to setup codec preferences go to How to set RTP codec preferences

4. File Uploads

The File Upload tab allows the upload of pre-defined configuration files. This can be useful if several phones need to be configured with the same or very similar parameters. On a PC the configuration files pinger-config and user-config are located in Program Files\SIPfoundry\sipxphone\meta and can also be manipulated using the Microsoft File Browser.

In addition, the File Upload Tab allows the upload of additional ring tones. This function is equivalent to the capability on the Home page.

By pressing the restart button the phone can be restarted.

5. SIP Log

The SIP Log can be very handy when troubleshooting phone behavior. Once enabled the log displayes SIP messages exchanged between sipXphone and another user agent or proxy.

The Preferences Tab

  

Lines

The concept of device and user lines is critically important to working with SIP VoIP solutions. Every sipXphone has one device line and optionally several user lines. Please refer to How to identify phones and users with lines for a detailed description of the concept of lines.

Note: The Enter Line Information dialog allows the definition of Authentication Credentials. We recommend not to use this feature. sipXphone includes a capability to restrict callers to pre-defined SIP URL's for which the phone has a set of credentials stored. This is rarely to never used, but if defined the wrong way could prevent your phone from accepting any incoming calls.

Note: In all cases where a SIP Directory Server or Proxy Server is used, Registration should be set to Register. This will cause the phone upon startup to look-up a host sipuaconfig.your.domain and register with the proxy and configuration server assumed to be available at that address.

  

Call Handling

Call handling parameters determine how incoming calls will be handled by a sipXphone. These parameters set:

  • Alert method for incoming calls
  • Call forwarding with destinations for forwarded calls
  • Call waiting
  • Do not disturb with redirection for incoming calls
  • Appearance of inbound caller IDs

For a detailed description refer to How to define incoming call handling

Personal tools