SIP Route Tester

The SIP Route Tester is an outbound test that enables you to configure your own SIP trunks and carrier routes, allowing you to make informed decisions on your carrier’s performance when dialing out from your network, in real time.

SIP Trunk Module

The SIP Trunk module enables you to configure your SIP trunks for testing. You can add new SIP trunks or edit existing trunks. Using the Carrier Details configuration panel, you can add custom carrier details to be used with your SIP Trunks.

Layout

1. SIP Trunk Module (The ‘SIP Trunk’ module is nested here in a tab which is located along the top of the page under the ‘Numbers’ module).  It is split in two sections with the same layout.
2. Carrier Details section allows you to Search/Add/Edit/View/Import/Export or Delete custom Carrier, Caller Line Identity (CLI), and Carrier Prefix details which can be used with your SIP Trunks.
3. SIP Trunk section allows you to Search/Add/Edit/View/Import/Export or Delete your SIP Trunk details.
4. Search function is provided on both tables.
5. Summary of details and Actions are available on both tables. Actions allow users to:
   1.  Edit (When clicked it brings up the Edit dialog box).
   2.  Delete (When clicked it brings up a confirmation dialog box to confirm deletion).
6. Add function is available on both tables.
7. Import/Export options are available on both tables.

---

How to Add a SIP Trunk

Note: If you would like to add several SIP Trunks at once try using the Import function. Click here to learn more.

To add a new SIP Trunk, do the following:

1. Navigate to the Numbers module of the platform  (this can be found here in the left-hand navigation menu).
2. Select the SIP Trunk tab (this is nested in the tabs which can be located along the top of the page).
3. Click the Add Sip Trunk button  (located center left of the screen).
4. In the ‘Add SIP Trunk’ dialog box, fill out the required fields listed below.
    

1. Trunk Name: Enter the name of your SIP Trunk here. The name is limited to 40 characters and must not contain any character other than letters, numbers, and hyphens.
2. Origination Country: Use the drop-down menu to select the origination country. Note: IP must be white-listed on your firewall to enable testing.
3. Copy IP: Click here if you would like to copy the selected origination country IP to your clipboard. The IP must be white-listed on your network if using the IP Trunk Termination Gateway.
   Note: You do not need to whitelist the IP if you will be using an authorized termination gateway!
4. Termination Gateway: Choose your termination gateway. If ‘Authorization’ or ‘Authorization with Registration’ is chosen it will add another level of security that requires further information to be added.
5. Transport: Select the Transport type from the drop-down menu.
6. Termination IP Address: Insert your Termination IP Address here.
7. Port: Enter the Port number to be used for the SIP trunk. The port field can have any number in the range of 1 to 65565.
8. SIP Domain: In most cases, this is not needed. This will ONLY be used for SIP Trunks where a domain is required for SIP calls.
9. SIP Number: This is needed if the termination gateway is set to ‘Authorization with Registration’.
10. Authorization Details: These are required if the termination gateway is set to ‘Authorization’ or ‘Authorization with Registration’
11. DTMF Mode: Choose how you would like to handle DTMF with your SIP trunk.
12. Codec Selection: Choose the appropriate codec to be used in line with your needs.
13. Dialing Format: Choose the dialing format to be used in line with your needs.
14. After Save: The after save menu gives you 2 options to choose from;
    1 – Add a new SIP Trunk: This will simply dismiss the dialog box and add the newly created Trunk to the list.
    2 – Edit this SIP Trunk: This will add the newly created trunk while keeping the current dialog box open to make any further edits.
15. Add: Click the Add button to complete your task.

Your task is now complete.

Results: The page will refresh and your SIP Trunk will now be available for you to search, edit or delete in the SIP Trunks List.

---

How to Add Carrier Details

Note: If you would like to add several sets of Carrier Details at once try using the Import function. Click here to learn more.

To add carrier details, do the following:

1. Navigate to the Numbers module of the platform  (this can be found here in the left-hand navigation menu).
2. Select the SIP Trunk tab (this is nested in the tabs which can be located along the top of the page).
3. Click the Add Carrier Detail button  which will bring up the ‘Add Trunk Prefix’ dialog box (the button is located to the right of the screen).
4. Fill in the required details which are briefly explained below.

1. Carrier Name: (This is a mandatory field. The carrier name is used to identify the carrier through which you will test on your network).
2. Carrier Prefix: (This prefix is used to identify which of your carriers Spearline should dial out of your network with. The prefix would be supplied to you by your carrier and is typically placed between the country code and the dialing number when calling; for Example – USA 001 9996667 800 23456).
3. Carrier CLI: (This is a mandatory field. Whatever number is input here will show up as the CLI (Caller Line Identifier) on any calls made through this carrier. This defaults to the word ‘Spearline’.
4. After Save: The after save menu gives you 2 options to choose from;
   1 – Add a new Trunk Prefix: This will simply dismiss the dialog box and add the newly created trunk prefix to the list.
   2 – Edit this Trunk Prefix: This will add the newly created trunk while keeping the current dialog box open to make any further edits.
5. Add: Click the Add button.

Your task is now complete.

Results: The page will refresh and your carrier details will now be available for you to search, edit or delete in the Carrier Details List.

---

Import/Export

SIP Trunk and Carrier Details can be imported in bulk to save time and effort.

To complete this task you must have a file containing the details you wish to import previously prepared. Click here for help with creating your import file.

---

How to import SIP Trunks

1. Navigate to the Numbers module of the platform  (this can be found here in the left-hand navigation menu).
2. Select the SIP Trunk tab (this is nested in the tabs which can be located along the top of the page).
3. Open the Import/Export options (the button is located top center of the screen) and choose Import. This will bring up the ‘Import SIP Trunk’ dialog box.
4. Click the ‘Choose File’ option to find the file containing your SIP Trunk details and then hit Submit to import the SIP Trunks.

---

How to export SIP Trunks

1. Navigate to the Numbers module of the platform  (this can be found here in the left-hand navigation menu).
2. Select the SIP Trunk tab (this is nested in the tabs which can be located along the top of the page).
3. Open the Import/Export options (the button is located top center of the screen) and choose Export. This will automatically download the SIP Trunks file to your downloads folder.

---

How to import Carrier Details

1. Navigate to the Numbers module of the platform  (this can be found here in the left-hand navigation menu).
2. Select the SIP Trunk tab (this is nested in the tabs which can be located along the top of the page).
3. Open the Import/Export options (the button is located top right of the screen) and choose Import. This will bring up the ‘Import Carrier Details’ dialog box.
4. Click the ‘Choose File’ option to find the file containing your Carrier Details and then hit Submit to import the details.

---

How to export Carrier Details

1. Navigate to the Numbers module of the platform  (this can be found here in the left-hand navigation menu).
2. Select the SIP Trunk tab (this is nested in the tabs which can be located along the top of the page).
3. Open the Import/Export options (the button is located top right of the screen) and choose Export. This will automatically download the carrier details file to your downloads folder.

---

How to Create an Import file

To create a CSV file, you can use any text editor or spreadsheet software. Here are some steps you can follow:

1. Open a text editor or spreadsheet software such as Microsoft Excel, Google Sheets, or LibreOffice Calc.
2. Create a new file.
3. You can change the descriptive headings in the first row if you wish, as long as the first character in the first column of the first row is the # symbol. The purpose of using the # symbol as the first character is to indicate that the row is a comment and should be ignored when the CSV file is processed by software.
4. Separate each column with a comma. For example, if you have three columns for Name, Age, and Gender, the first row of your CSV file would look like this: “#Name, Age, Gender”
5. For each row of data, enter the values for each column separated by commas.
6. Make sure each row ends with a line break or newline character, which is usually done by pressing the “Enter” or “Return” key on your keyboard.

Once you have entered all the data, save the file with a .csv extension. When saving, make sure to select “CSV” as the file type, so the software will save it in the correct format.

Note that different software may have slightly different ways of creating and saving CSV files, so you may need to refer to your software’s documentation for specific instructions.

---

SIP Trunk File Tips

When creating your .csv file there are a few things you should know.

1. There are 14 fields expected per row.

• #Trunk Name
• Origination Country
• Termination Gateway
• Transport
• Termination IP Address
• Port
• SIP Domain
• SIP Number
• Username
• Password
• From Username
• DTMF Mode
• Codec Selection
• Dialing Format

2. All fields are required, except where specified. Non required fields can be left empty.
3. The SIP Trunk name is limited to 40 characters and must not contain any character other than letters, numbers, and hyphens.
4. You can contact your CEM or Spearline Support if you wish to obtain a full list of Origination Country IPs.

Expected fields described:

1. Trunk Name: Enter the name of your SIP Trunk here. The name is limited to 40 characters and must not contain any character other than letters, numbers, and hyphens.
2. Origination Country: Contact your CEM or Spearline Support if you wish to obtain a full list of Origination Country IPs.
3. Termination Gateway: Choose either IP Trunk, Authorization or Authorization with Registration.
   Note: If ‘Authorization‘ or ‘Authorization with Registration’ is chosen it will add another level of security that requires further information to be added.
4. Transport: Select the Transport type. Your options here are UDP, TCP or TLS
5. Termination IP Address: Insert your Termination IP Address here.
6. Port: Enter the Port number to be used for the SIP trunk. The port field can have any number in the range of 1 to 65565.
7. SIP Domain: In most cases, this is not needed and may be left blank. This will ONLY be used for SIP Trunks where a domain is required for SIP calls.
8. SIP Number: This is needed ONLY if the termination gateway is set to ‘Authorization with Registration’.
9. Authorization Details: These are required if the termination gateway is set to ‘Authorization‘ or ‘Authorization with Registration’
10. DTMF Mode: Choose how you would like to handle DTMF with your SIP trunk. Your options here are Inband, rfc2833 or Info.
11. Codec Selection: Choose the appropriate codec to be used in line with your needs. Your options here are PCMU or PCMA.
12. Dialing Format: Choose the dialing format to be used in line with your needs. Your options here are E164 or +E164.

---

Carrier Details File Tips

When creating your .csv file there are a few things you should know.

1. There are 3 fields expected per row.

• #Carrier Name
• Carrier Prefix
• Carrier Cli

2. Carrier Prefix is a non-mandatory field.
3. Non required fields can be left empty.
4. The Carrier Name and Carrier Prefix are limited to 40 characters and must not contain any character other than letters, numbers, and hyphens.

Expected fields described:

1. Carrier Name: This is a mandatory field. The carrier name is used to identify the carrier through which you will test on your network.
2. Carrier Prefix: This prefix is used to identify which of your carriers Spearline should dial out of your network with. The prefix would be supplied to you by your carrier and is typically placed between the country code and the dialing number when calling; for Example – USA 001 9996667 800 23456.
3. Carrier CLI: This is a mandatory field. Whatever number is input here will show up as the CLI (Caller Line Identifier) on any calls made through this carrier. This defaults to the word ‘Spearline’.