Zoiper 5

From VoIP.ms Wiki

Contents 1 Basic setup 1.1 Setting up Zoiper with your SIP/IAX credentials 2 Advanced setup and features 2.1 Audio codecs 2.2 Network settings 2.3 Call Encryption TLS/SRTP 2.4 SMS SIP Account 2.4.1 Receiving SMS 2.4.2 Sending SMS 2.5 Busy Lamp Field (BLF) 3 Common Errors 3.1 No transport mode found 3.2 SIP error codes 3.2.1 403 error

Basic setup

This is the very basic set up for Zoiper 5, there are only 6 steps needed to have your device up and running. Refer to the advanced section if you want to improve your softphone performance and use some of the softphone features.

Setting up Zoiper with your SIP/IAX credentials

Step 1 - Download and install Zoiper 5 Softphone from this link.

Step 2 - Start Zoiper 5 and on the welcome screen, use your SIP/IAX credentials to fill the Username and Password then click on Login.

• Username: 100000 (replace with your main VoIP.ms account number* or sub-account name)
• Password: ********* (replace with your main SIP/IAX password* or sub-account password)
  

*Note 1: New accounts have received these main SIP/IAX credentials by e-mail when the account was created. By default, your 
main SIP/IAX password is the same you use to log into your customer portal, however, for old accounts they could be 
different if the portal password has been changed in the past. If you're not sure about your Main SIP/IAX password, 
update it from your customer portal at Main Menu>> Account Settings>> Security tab>> Main SIP/IAX password.

Step 3 - On the host screen, fill the Hostname or Provider with any of our servers, i.e. toronto.voip.ms then click on Next.

Note 2: Bear in mind to use the same VoIP server your VoIP number is using. You can check what VoIP server 
your VoIP number is using, from your VoIP.ms customer portal at DID Numbers>> Manage DIDs, under POP column.  
You can choose any server you want, as long as the one in your portal and the one in this field matches, otherwise, 
incoming calls won't ring.

Step 4 - The Authentication step is optional, you can skip it.

Step 5 - In this screen, you can select the protocol your account will use:

• SIP TLS
• SIP TCP
• SIP UDP
• IAX UDP

Select the one you prefer according to your network's settings, i.e. SIP TCP then click on the Next button.

Note 3: If all these options show "Not found" but the Hostname is fine, just click Finish.

If you chose TLS please refer to section 2.3 for some extra adjustments, only if they are needed. When choosing TLS, Zoiper should adjust these parameters automatically.

Step 6 - At this point your VoIP.ms account should be marked with a Green tick arrow next to its name. This means your softphone is ready to start placing calls. In case of failure, your account will be marked on Red and will display an error code. You can have more information about this error and how to fix it from section 3.2.

Note 4: Bear in mind to set the Caller ID Number for your outgoing calls from your customer portal. If you're using the 
main account at Main Menu>> Account Settings>> General tab>> Caller ID Number. If you're using a sub account at 
Sub accounts>> Manage Sub Accounts>> Edit Sub-account (orange icon with a pen)>> Caller ID Number.

Finally, you can check if your account is registered from your customer portal, at the main page. If your account is now registered and you have set your caller ID number for outgoing calls, you will be able to start placing outgoing calls.

Advanced setup and features

Audio codecs

In order to use only supported codecs by VoIP.ms please go to Settings (gear icon next to account's name)>> Accounts>> Your account>> Advanced and scroll down the page to Audio Codecs section. You can hover over any codec and move it to the other column or change the order by using the gray arrow buttons. We suggest keeping audio codecs G729, G711 mu-law and GSM in Selected Codecs column and in this order.

Network settings

In order to have your softphone running all the time, proceed with the following steps:

1. Go to Settings>> Accounts>> Your account>> Advanced and scroll down the page to Network Related and apply the following changes:

• Registration expire mode: Custom
  
• Registration expiry: 300
  
• NAT keep alive time-out: Custom
  
• Keep alive custom interval: 30
  

Done, at this point you have configured your softphone to work within our service using the best settings. These settings will help you to place and don't miss any incoming call.

Call Encryption TLS/SRTP

If you decided to use SIP TLS - call encryption along with Zoiper please follow these steps:

1. Make sure your Main account or sub-account has "Encrypted SIP Traffic" enabled.

Bear in mind, if this setting is enabled and your device sends UDP/TCP or RTP you will be rejected 
with error code 488.

Enable this setting for the Main Account at Main Menu>> Account settings>> Advanced tab.

For a sub-account enable it at Sub accounts>> Manage sub-accounts by clicking on the orange icon with a pen and finally click at "Advanced Options (Click here to display)".

2. Now that your account/sub-account has this setting enabled, your device only needs to send TLS and SRTP.

To enable TLS, go to Settings>> Accounts>> Your Account>> Advanced and at SIP Credentials section type:

• Domain: toronto1.voip.ms:5061 (Use the same server your phone number is at, you can check it out from your customer portal at Manage DIDs section, under POP column)
• Username: Your account's number or sub-account name
• Password: Your SIP/IAX password

Note: When using TLS is very important to specify the number of the server, in case the server's name doesn't have the number "1" included, you need to add it. Adding any of the SIP ports 5061/5081/42873 at the end of the Hostname is also required.

Now scroll down the page to Network Related section and set Transport to TLS.

To enable SRTP, scroll down the page and at Encryption section set SRTP Key Negotiation to SDES.

Your account should be shown as registered and when you place a call you will see a green closed padlock, which means the call is now secure.

You can also check if Zoiper is fully registered and using SIP-TLS protocol from your customer portal at Home page, Main menu>> Portal Home for each account/sub account registered or at Sub Accounts>> Manage Sub accounts tab to see all of your Sub Accounts registration status.

A green padlock will appears on the right of "Registered" in green. If you don’t see the padlock, you need to revalidate some configuration.

SMS SIP Account

Zoiper is able to send and receive SMS using the SIP MESSAGE header. In order to use this feature along with Zoiper, there are some settings you need to adjust from your customer portal and your VoIP.ms number must support SMS service.

Bear in mind this feature is in BETA phase and we can't guarantee will work all the time.

Note: If your SIP device is offline, undelivered SMS will be trying to reach it during the next 24 hours after 
they were received. After this time, they won't be delivered in your SIP device BUT they won't be lost. 
You can check all your SMS from your customer portal at DID Numbers>> SMS Message Center at anytime. 

Receiving SMS

You can use your Main Account or a Sub-account; from your customer portal enable the following:

1. Go to DID Numbers>> Manage DIDs section and click at Edit DID (orange icon with a pen), at the bottom of this section you will find Short Message Service (SMS) section. Make sure the following are enabled and ticked:

• Short Message Service (SMS): Enabled.
  
• SMS SIP Account BETA: Choose the Main Account or Sub-account you are currently using in Zoiper.
  

At this point, you should be able to receive incoming SMS in Zoiper, they will show up under the Messages section in Zoiper. You can also reply to this message using the same thread.

Sending SMS

You can use your Main Account or a Sub-account; from your customer portal enable the following:

1. Your Main Account or Sub-account is using the phone number with SMS service enabled as its own caller ID number. You can check this for your Main Account at Main Menu>> Account settings>> General tab and for a Sub-account at Sub accounts>> Manage Sub accounts by clicking at Edit Sub-Account (orange icon with a pen).

2. Starting a new SMS from Zoiper 5 requires to add this number as "Contact" first. You can't start a new SMS by just typing the number.

3. To add a contact in Zoiper click at Contacts>> Add/Import Contact (+ icon)>> Add contacts and type your contact's personal information. To add the phone number click at Add aditional field>> Phone and fill the following:

• Phone: Type the destination number using 10 digits.
  
• Dial Account: Choose the name of the SIP account you're currently using in Zoiper.
  
• Presence Account: Choose the name of the SIP account you're currently using in Zoiper.
  

4. Now you can start sending SMS by using the chat window in Zoiper 5.

Busy Lamp Field (BLF)

You can use BLF feature to see the "Status" of any of your extensions. Currently, 3 states are possible: Available, On the phone and Offline.

In order to use this feature, you need to enable "Presence" for the VoIP.ms server your 
sub-accounts/extensions are using. Contact technical support in order to enable it for your account.

Once this feature has been enabled for your account, make sure to enable the following in Zoiper:

1. Go to Settings>> Accounts>> Your account>> Advanced and at Features section make sure the following are enabled:

• Subscribe Presence
  
• Use BLF
  

You can keep Publish Presence as disable.

2. Now, you only need to create a "Contact" entry from Zoiper and add the "Sub-account name" in the "Phone" field. If you already have a contact entry created you can add another "Phone" field and type the sub-account name in this new field, as follows:

• Phone: Type the subaccount name.
  
• Presence Account: Choose the name of the SIP account you're currently using in Zoiper.
  

For example, this contact has the phone number "1234567890" assigned and it also has a second phone number field on where the sub-account name "100000_101" is typed. This way this contact will show the status of the sub-account 100000_101.

3. Now, you should be able to see if this extension is Available, On the phone or Offline.

When you click on the phone icon for this contact you have the option to dial the phone number "1234567890", for the example above, or directly to the sub-account "100000_101" using internal extensions calling.

Common Errors

No transport mode found

If there was a typo in the hostname or if there's a network DNS issue, Zoiper might show the account type options in red. You can select the protocol you want and hit Skip button even though, they're all red. Finally, click at Create an account.

Note: Sometimes even when the username, password and server's name were typed fine, Zoiper will show all 
those options as "Not found" in red. However, you can choose your desired selection and hit Skip and Create an account.

SIP error codes

In case of failure registering your device, an error code number will be shown at Settings>> Accounts>> Your account section. You can check the error response code and correct it by checking the list of common SIP Response codes.

403 error

This is the most common error you can get and it's related to wrong information in your username and/or password. Please make sure you have the right credentials and no blank spaces are in your username or password