VitalPBX

From VoIP.ms Wiki

Latest revision as of 16:02, 30 August 2023

This article will provide you with guidance on configuring your VitalPBX.

Configuring PJSIP using User and Password Authentication

Head into VitalPBX and go to PBX >> Calls Routing >> Trunks to create a trunk with the following parameters:

• Description: Any name to identify your trunk.
• Profile: Optional. Recommended to be set to the “Default PJSIP Profile”. To edit the Default PJSIP profile or create your own go to "Settings >> Technology Settings >> Device Profiles".
• Codecs: Recommended to use G.722* (G.711u, G.729a and GSM are also supported).
• Trunk CID
  • Trunk CID Name: The name you want to display on outbound calls*
  • Trunk CID Number: The DID number you want to display on outbound calls
• Overwrite CID: Set to No to control the CID from the extension or outbound route. Can be set to “If not provided” in order to allow external incoming caller ID during call forwards.

 *IMPORTANT: The Main and Sub-Accounts use codec G.711u as priority by default. To use G.722 go to the advanced settings of the account you'll configure in the trunk.

*IMPORTANT: 
  - We suggest entering your outbound Caller ID Name must be in CAPITAL LETTERS. This will appear more clearly/visible on some devices.
  - You must NOT use any special characters, they will not be displayed. 
  - Do not exceed 15 characters max! Some of the regular Canadian providers will not show more than 15 characters. We suggest shrinking or adapting your caller ID. 
  - Spaces are allowed in a caller ID name.

General Configurations

• Local User: This is the name of your trunk. It can be anything of your liking.
• Remote Host: Your Preferred VoIP.ms server (Recommended to use one near to your location and use the same as the POP of your DIDs). To see the list of servers click here.
• Contacts: SIP URI with one of the multiple servers from VoIP.ms. (E.g. sip:[email protected])
• Match: Same as the Remote Host.
• Remote Username: Your Main or Sub-Account SIP username.
• Remote Secret: Your Main or Sub-Account password.
• From User: Same as Remote Username.
• From Domain: Same as Remote Host.
• Contact Header: Same as Remote Username.

Outbound Registration Settings

• Require Registration: Must be set to “Yes”.
• Permanent Auth Rejection: Must be set to “Yes”.
• Client URI: A SIP URI composed of your Main or Sub-Account username and your preferred VoIP.ms server.
• Server URI: Your preferred VoIP.ms server.

Configuring PJSIP using IP Authentication

In case you would like to use IP authentication instead of a User and Password, here, we will show you how to do it.

This will be the required configuration:

 IMPORTANT: Remember, to be able to use IP authentication you will need to create a sub-account. The main account is not capable of handling this type of authentication.

• Description: Any name to identify your trunk
• Profile: Optional. Recommended to be set to the “Default PJSIP Profile”. To edit the Default PJSIP profile or create your own go to "Settings >> Technology Settings >> Device Profiles"
• Codecs:' Recommended to use G.722* (G.711u, G.729a and GSM are also supported)
• Trunk CID
  • Trunk CID Name: The name you want to display on outbound calls*
  • Trunk CID Number: The DID number you want to display on outbound calls
• Overwrite CID: Set to No to control the CID from the extension or outbound route. Can be set to “If not provided” in order to allow external incoming caller ID during call forwards.

 *IMPORTANT: The Main and Sub-Accounts use codec G.711u as priority by default. To use G.722 go to the advanced settings of the account you'll configure in the trunk.

General Configuration

Here you will omit the Remote Username and the Remote Secret fields.

• Local User: This is the name of your trunk. It can be anything of your liking.
• Remote Host: Your Preferred VoIP.ms server (Recommended to use one near to your location and use the same as the POP of your DIDs). To see the list of servers click here.
• Contacts: SIP URI with one of the multiple servers from VoIP.ms. (E.g. sip:[email protected])
• Match: Same as the Remote Host.
• From User: Same as Remote Username.
• From Domain: Same as Remote Host.
• Contact Header: Same as Remote Username.

Outbound Registration Settings

• Require Registration: Must be set to “No”.
• Permanent Auth Rejection: Must be set to “No”.

Configuring Outbound Routes on VitalPBX

In order to place calls, you will need to create an outbound route pointing to the trunk that was created previously.

To add an Outbound Route go to PBX >> Call Routing >> Outbound Routes.

To allow national and international phone calls you can add the following patterns:

• NXXNXXXXXX
• 1NXXNXXXXXX
• 00.
• 011.
• 4XXX (To be able to perform the Sound Quality test and DTMF test)

 The pattern 4XXX will allow you perform the Sound Quality test and DTMF test.

 Make sure to enter the dot (.) after the International codes 00 and 011. This will allow any digits after the code.

Configuring Inbound Routes on VitalPBX

To receive calls, you need to create Inbound Routes for the DID number(s) in your VoIP.ms account.

To add inbound routes in VitalPBX go to PBX >> Call Routing >> Inbound Routes.

Under General set a description and the DID pattern of your DID(s).

 Please note that in the DID pattern option, you can define a specific DID or a pattern using wildcards.

Under Inbound Destination make sure to select the feature or extension that will manage the inbound calls received by this route.

Adding an Extension

Once you have configured the Trunk and the routes you will use with it, you will have to add extensions for your IP phones, softphones, ATAs or any other devices that will be provisioned with the VitalPBX trunk that is registered in VoIP.ms.

To add an extension, in VitalPBX go to PBX >> Extensions. There, enter the following information:

• Extension: Enter the internal extension number.
• Name: Enter a name to identify this extension.
• Internal CID:
• Name: A name to display on internal calls
• Number: A number to display on internal calls (Usually the same as the extension number).
• External CID:
• Name: Set a name to display on external calls.*
• Number: Set the DID number that this extension will use as caller ID.

*IMPORTANT: 
  - We suggest entering your outbound Caller ID Name must be in CAPITAL LETTERS. This will appear more clearly/visible on some devices.
  - You must NOT use any special characters, they will not be displayed. 
  - Do not exceed 15 characters max! Some of the regular Canadian providers will not show more than 15 characters. We suggest shrinking or adapting your caller ID. 
  - Spaces are allowed in a caller ID name.

Whitelisting VoIP.ms IPs in VitalPBX

Whitelisting IP address in VitalPBX is very easy. To whitelist the IP address of the VoIP.ms server or servers you will use, go to Admin >> Firewall >> Access Control.

There, simply click on "+ Whitelist an IP" to add the server(s) that you want to whitelist.

From the Rules section under Firewall you can also create rules depending on your network needs.

For more information on the IPs related to our servers, click here
For more information on the VitalPBX settings, click here

SMS Module Installation and Configuration

VitalPBX 4 introduced SMS capabilities for SIP trunks and this can be easily integrated with VoIP.ms's SMS service.

Here you will learn how to set up this.

1. Enabling the VoIP.ms API

The SMS module of VitalPBX integrates using the VoIP.ms API, thus it needs to be enabled beforehand in the VoIP.ms Customer Portal.

1. First, you should login to your customer portal
2. Once logged in, head to Main menu>>SOAP and REST / JSON API at https://voip.ms/m/api.php
3. Here, you will need to set your API Password and Enable API. You will also need to allow your VitalPBX to connect to the API by entering its IP address and clicking “Save IP Addresses”

Enabling the VoIP.ms API

2. Installing the SMS Module

The SMS module is not integrated in VitalPBX by default, this needs to be installed as an Add-On.

To do so, in your VitalPBX interface go to Admin >> Add-ons. Click on "Check online" to get the list of available add-ons, locate the SMS option and click on the install option on the right.

 Please note you need a license that includes this module in order to use it.

3. Configuring the SMS module

Once you have installed the SMS module in VitalPBX and enabled the API in the VoIP.ms portal, SMS can be configured.

The SMS module can now be found under the "PBX" menu of VitalPBX. Click on it and then click on "Messaging Providers".

On the providers list select VoIP.ms, set a description, and enter your API username* and API password.

 *The API username is the same email you use to log into the VoIP.ms customer portal.

Once this is done the VoIP.ms API will connect with VitalPBX and Weebhook URL will be created. This URL is what you will use to perform SMS callbacks between VitalPBX and VoIP.ms, copy it since you'll need it later.

To pull all the DIDs in your VoIP.ms account and have them available in VitalPBX click on the button "Get Numbers from API". If you only want to add one manually then click on "+Add Number". After this you'll see a list of the DIDs available to use as shown below.

4. Assigning a DID for SMS to an Extension

To receive and send messages with an extension using one of your VoIP.ms DIDs you will need to assign it from the configuration of the extension.

To do this, in VitalPBX go PBX >> Extensions. Click on the button on the right to see the list on extensions and click on the one you will edit.

In the configuration of the extension, click on the Advanced tab and on the option SMS Number select the DID that you want to use for this as shown below.

5. SMS Configuration in VoIP.ms

Finally, after you have installed, configured, and connected the SMS module with the API, you'll need to set up in the configuration of your DID the Webhook URL you got in step #3.

For this, log into your VoIP.ms Customer Portal, go to DID numbers >> Manage DIDs and click on "Edit" for the DID you assigned to the extension. In the Edit DID settings page scroll to the bottom and locate the SMS configuration.

There, set the following:

• Message Service (SMS/MMS): Checked.
• Link the SMS received to this DID to a SIP Account: Check and select the Sub-Account you use to register the trunk in VitalPBX.
• SMS/MMS URL Callback: Check and paste the Webhook URL that was generated in the SMS module of VitalPBX.

Apply changes when done.

Now your VitalPBX is ready to send and receive messages using your VoIP.ms DIDs.

Resources

VitalPBX installation guide: How To Install A PBX System In 2023 With VitalPBX 4.0

VitalPBX SMS integration: Innovative SMS Integration For VitalPBX 4 And Your Business