X-Lite Settings &
HowTo
This page describes how to set up and use X-Lite Version 3.0 from
CounterPath. This is a free, feature-rich soft-phone client that works.
You can download the client from this site: http://www.counterpath.com/x-lite.html.
If you need more info about the phone than
what you see on this page or you are using a different version of the
phone, check out the documentation on this phone
and the user manual from the website.
The term 'SIP server' is used throughout this document to denote
CafeSip's SipExchange server
(http://www.cafesip.org/projects/sipexchange/index.html) or CafeSip's
Jiplet Container with the Jiplet Reference Application
(http://www.cafesip.org/projects/jiplet/jiplet_ref_app_howto.html)
installed on the Jiplet Container. Both of these provide SIP
registration, proxy and presence functionality that the client phone
can use.
When you first bring the phone up on your machine, this is how it looks.
Contents:
Creating an Account on the
Phone
To create an user on the phone, hold your mouse over the phone and
right click. You'll see a menu popup:
Click on "SIP Account Settings". You'll get a table where you can add
users hosted by this phone. Click the "Add" button.
A properties page pops up that allows you to fill in the properties for
the new account you are adding. The "Authorization user name" and
"Password" are what you want to put for authenticating with the SIP
server. If your SIP server is the Jiplet Container with the Jiplet
Reference Application, you can configure your phone with pre-defined
users "amit" or
"becky" with password = a1b2c3d4, and use Domain cafesip.org. If your
SIP server is SipExchange, you will need to have defined a domain and
subscriber on the server as part of post-installation, and use that
information here for the SIP phone account. The value
for "proxy" is the address where the SIP server is running. Note
the use of ":port" which is only needed if the SIP server's SIP
stack is using a port other than the default 5060 for SIP (this is
configured in the SIP server's server.xml file, connector, jip-ports
parameter). Fill in
remaining items as indicated.
Next, click on the "Topology" tab. Those properties should look like
this:
Finally, click on the "Presence" tab. By default, presence is disabled.
Change it to "Presence Agent" mode. This way you'll be able to add
contacts and view their presence status.
This is all you need to set - the remaining account settings' defaults
work fine. Click "OK". When you do that, you'll see that the account
has been added and is activated (enabled, checked), as below. At this
point, you should start up the SIP server if it's not already
running because as soon as you click the "Close" button, the phone will
attempt to register with the server. If the SIP server isn't
running when you hit the 'Close' button, you'll see the registration
attempt timeout.
Click the "Close" button. This completes configuration of a new account
on the phone.
How To Register and
Unregister With the Server
Registration
When you complete the above configuration, and thereafter whenever you
start up your SIP phone application, if the SIP server is running, the
phone will automatically and immediately register with the SIP server.
A successfully
registered phone says "Ready" in the window, like so:
If registration fails, check that the SIP server is
running and check your phone settings for matching proxy address as
described in the "Creating an account" section above.
Unregistration
To unregister from the server (log out), hold your mouse over the phone
and
right click. You'll see a menu popup:
Click on "Exit" to quit the phone application. This will unregister the
SIP user from the SIP server.
How To Make a Call
One way to make a call is to go offhook by clicking the green "phone
off-hook" icon near the digit 1 on the keypad, or click on either of
the 2 voice lines marked "1" and "2" under the display window:
In any case, you'll hear dial tone and you can then just start typing
the URI of the user you want to call (ie, becky@cafesip.org) and hit
Enter. When the called party rings, you'll see an alerting indication
in the display window of the phone, and when the called party answers
you'll have voice path with an indication of call established in your
phone's display window.
Another way to initiate a call is to select an entry from your calls
made/received/missed list or your contacts list by first clicking the
little white arrow on the right-hand edge of the phone to open up the
lists:
A side window will pop out - click on the vertical "Calls" or
"Contacts" tab:
Select an entry, right click, and make the call:
As in the previous example, when the called party rings you'll see an
alerting indication in the
display window of your phone, and when the called party answers you'll
have voice path with an indication of call established in your phone's
display window.
Receiving Incoming
Calls
When someone is calling you, you'll hear ringing and your phone will
indicate an incoming call and who it's from:
To answer the call, click on the green "phone off-hook" icon near the
keypad digit 1. You'll have voice path with an indication of call
established in your phone's display window.
How To See Calls
Sent, Missed and Received
To see calls sent, missed and received, open your call list by clicking
the little white arrow on the right edge of the phone:
A side window will pop out - click on the vertical "Calls" tab:
There you'll see calls received, missed, and made. Hovering over an
entry gives information about that particular call like duration,
whether it was answered or not, etc. You can select an entry and do
things with it like call the person, add him/her as a contact, etc.
How To See Your
Contacts
Open your contact list by clicking the little white arrow on the right
edge of the phone:
A side window will pop out - click on the vertical "Contacts" tab:
There you'll see your contacts and contact groups. You can do alot of
things like call a contact, sort the list, manage groups, etc.
How To Add a Contact
There are a number of different ways to add a contact to your contacts
list.
Adding the Person
You're Talking To
If you are in conversation with someone and you want to add him/her to
your contacts list, click on the icon in the display window that shows
a green person with a plus "+" sign (see the mouse pointer):
A page will pop up that shows the user's information and allows you to
select the group(s) you want to add the contact to as well as enter
additional information you want to store about the contact:
Click "OK" and you're done.
From Your Call List
Open your call list by clicking the little white arrow on the right
edge of the phone:
A side window will pop out - click on the vertical "Calls" tab:
There you'll see calls received, missed, and made. You can select one
of them, right click, and add the person to your contacts list:
A page will pop up that shows the user's information and allows you to
select the group(s) you want to add the contact to as well as enter
additional information you want to store about the contact:
Click "OK" and you're done.
From the Add Contact
Screen
Open your contact list by clicking the little white arrow on the right
edge of the phone:
A side window will pop out - click on the vertical "Contacts" tab:
There you'll see your contacts and contact groups. You can either
select "Add Contact" from the "Contacts" dropdown or you can select a
group, right click, and add a contact:
A page will pop up that allows you to enter a little or alot of
information about the contact you are adding:
Enter the information you want to save and click the "Show this
contact's Availability" checkbox.
Click "OK" and you're done.