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.xten.com/index.php?menu=download. If you need more info than what you see on this page, check out the documentation on this phone and the user manual from the http://www.xten.com website.

When you bring the phone up on your machine, this is how it looks.

the-phone.jpg


Contents:

Presence Behavior Notes

When the X-Lite user logs in and a contact in the buddy list is off-line, the phone starts a subscription but it is immediately dropped because the SUBSCRIBE response has no Contact Header (the contact is offline). When the contact later comes online, the X-Lite phone does not pick up the status change immediately due to the dropped subscription. However, after some time, the X-Lite phone re-subscribes and then shows the contact's online status.

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:

show-account-settings-popup.jpg

Click on "SIP Account Settings". You'll get a table where you can add users hosted by this phone. Click the "Add" button.

account-settings.jpg

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, which is the Jiplet Container in this case. For the Jiplet reference application that works with Jiplet Container, you can use "amit" or "becky" with password = a1b2c3d4, and use Domain cafesip.org. The value for "proxy" is the address where the Jiplet Container is running. Note the use of ":port" which is only needed if the Jiplet Container's SIP stack is using a port other than the default 5060 (configured in the container's server.xml file, connector, jip-ports parameter). Fill in remaining items as indicated.

account-properties.jpg

Next, click on the "Topology" tab. Those properties should look like this:

account-topology.jpg

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.

account-presence-properties.jpg

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), below. At this point, you may start up the Jiplet Container 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 Jiplet Container isn't running, you'll see the registration attempt timeout.

account-activation.jpg

Click the "Close" button. This completes configuration of a new account on the phone.

How To Register and Unregister With the Server

Registration

To register with the server (log in), hold your mouse over the phone and right click. You'll see a menu popup:

show-account-settings-popup.jpg

Click on "SIP Account Settings". You'll see the list of accounts (one in this case).

unregistered.jpg

If the "Enabled" check-box is already checked, then your phone is already registered with the server. Otherwise, check the box and hit "Close". When you do that, you'll see the phone registering with the server. If registration fails, check that the Jiplet Container is running and check your phone settings for matching proxy address as described in the "Creating an account" section above. A successfully registered phone says "Ready" in the window, like so:

active-phone.jpg

Unregistration

To unregister from the server (log out), hold your mouse over the phone and right click. You'll see a menu popup:

active-account-rightclick.jpg

Click on "SIP Account Settings". You'll see the list of accounts (one in this case).

active-account-settings.jpg

If the "Enabled" check-box is already unchecked, then your phone is not registered with the server. Otherwise, uncheck the box and hit "Close". When you do that, you'll see the phone de-registering with the server. A successfully unregistered phone says "No SIP accounts are enabled" in the window:

the-phone.jpg

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:

initiate-call.jpg

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.

call-made.jpg

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:

open-callcontact-list.jpg

A side window will pop out - click on the vertical "Calls" or "Contacts" tab:

call-a-contact.jpg

Select an entry, right click, and make the call:

call-a-contact2.jpg

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:

incoming-call.jpg

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.

answered-call.jpg

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:

open-contacts-drawer.jpg

A side window will pop out - click on the vertical "Calls" tab:

open-calls-list.jpg

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:

open-contacts-drawer.jpg

A side window will pop out - click on the vertical "Contacts" tab:

open-contacts-list.jpg

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):

add-live-contact.jpg

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:

add-contact-page.jpg

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:

open-contacts-drawer.jpg

A side window will pop out - click on the vertical "Calls" tab:

open-calls-list.jpg

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:

add-contact-from-calllist.jpg

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:

add-calllist-contact.jpg

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:

open-contacts-drawer.jpg

A side window will pop out - click on the vertical "Contacts" tab:

open-contacts-list.jpg

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:

add-contact-from-contactlist.jpg

A page will pop up that allows you to enter a little or alot of information about the contact you are adding:

add-detailed-contact.jpg

Enter the information you want to save and click the "Show this contact's Availability" checkbox.

Click "OK" and you're done.