Incredible PBX 2027

[[File:IncrediblePBX-VoIPms.jpg|300px|right|link=https://incrediblepbx.com/|IncrediblePBX]]

Incredible PBX is an open source, GPL aggregation which bundles industry-leading components to provide a production-ready, turnkey unified communications VoIP platform with support for SIP and IAX. IncrediblePBX® includes a choice of CentOS®, Rocky®, Debian®, Ubuntu®, or Raspbian® operating systems coupled with the Apache® web server, PHP®, MariaDB®/MySQL® DBMS, SendMail® or Exim® mail server, HylaFax®/AvantFax®, WebMin®, OpenVPN®, NeoRouter® VPN, IPtables firewall plus Fail2Ban® and PortKnocker®, and the latest releases of Asterisk® and FreePBX®. It is the only aggregation offering the ability to customize and recompile Asterisk from source code with your choice of Asterisk versions. Versions of Incredible PBX can be deployed with on-premise hardware including the Raspberry Pi®, in the cloud on a variety of platforms, or on virtual machine platforms: VirtualBox®, VMware®. and Proxmox®.


== Pre-requisites ==

=== Sub-Account (Trunk) ===
Before proceeding, a sub-account is required. This will be your SIP trunk:
:- '''Authentication type''': (x) User/Password Authentication
:- '''Device type''': (x) Asterisk, IP PBX, Gateway or VoIP Switch
:- '''CallerID Number''': (x) I use a system capable of passing its own CallerID
:- '''Allowed Codecs''': Only select '''[x] G722''' for HD voice


= Trunk Configuration =

When you install IncrediblePBX, it comes with multiple trunk preset that helps you to get up and running faster. VoIP.ms is present in the list.

We will reuse the one that is already present and adapt the configuration.

:[1] Log into your IncrediblePBX admin.
:[2] Go under '''"Connectivity"''' tab then '''"Trunk"'''.
:[3] Search for the trunk '''"VoIPms-Registered"''' and click on '''"Edit"'''

== General Tab ==

: '''Trunk Name''': You can change the name of the trunk. Must be in lowercases. Hyphen is accepted.
: '''Outbound CallerID''': (Optional, you can leave it empty and define the caller ID on your outbound route instead. 
:: If you want to define a specific outbound caller ID Name and Number for all outbound calls that will use this trunk. 
:: If you do so, after setting the caller ID, you will need to select '''Force Trunk CID''' on the ''CID Option''. The format whould be:

<div style="margin-left:50px; 
            padding:5px; 
            font-family: Consolas, Monaco, Lucida Console, Liberation Mono, DejaVu Sans Mono, Bitstream Vera Sans Mono, Courier New, monospace;
            color: silver;
            border-left: 6px solid rgb(208, 56, 45, 0.8); 
            box-shadow: 8px 6px 9px -2px #f2f2f2;
            background-color: black; 
            width:58%;">

:: "CALLERID NAME" <##########>
</div>


<div style="margin-left:50px; 
            padding:8px; 
            border-left: 6px solid rgb(73, 111, 199, 0.8); 
            box-shadow: 5px 4px 4px 4px #f5f5f5; 
            background-color: rgba(73, 111, 199, 0.08); 
            width:70%;">

'''IMPORTANT - Outbound CallerID'''<br/>
* Entering outbound Caller ID Name, it must be in '''CAPITAL LETTERS'''. ''This will appears more clearly/visible on some devices.'' <br/>
* You must '''NOT use any special characters'''. ''They will not be displayed and it prevents potential outbound call issues.'' <br/>
* Do '''NOT exceed 15 characters'''. ''Traditional canadian providers will '''not show more than 15 characters'''. We suggest shrinking or adapt the name.''<br/>
* Spaces are allowed in a caller ID name but count as a characters. ''(do not exceed 15 chars. in total)''.
</div>
: '''Disable Trunk''': Set it to '''No'''

== Dial Number Manipulation Rules Tab ==


== sip Settings Tab ==
=== Outgoing ===
You will need to adapt the '''PEER Details'''
: '''Trunk Name''': You can change the name of the trunk. Must be in lowercases. Hyphen is accepted.
: '''PEER Details''': Change the '''username''', '''secret''', '''host''', '''fromuser''', '''allow'''

<div style="margin-left:50px; 
            padding:5px; 
            font-family: Consolas, Monaco, Lucida Console, Liberation Mono, DejaVu Sans Mono, Bitstream Vera Sans Mono, Courier New, monospace;
            color: silver;
            border-left: 6px solid rgb(208, 56, 45, 0.8); 
            box-shadow: 8px 6px 9px -2px #f2f2f2;
            background-color: black; 
            width:58%;">

: username=######_SubAccount
: type=friend
: trustrpid=yes
: sendrpid=yes
: secret=yourpassword
: qualify=yes
: nat=yes
: insecure=port,invite
: host=atlanta.voip.ms
: fromuser=######_SubAccount
: disallow=all
: context=from-trunk
: canreinvite=nonat
: allow=g722&ulaw
</div>





=== Incoming ===

Adjust the '''register String''' with your sub-account credentials. It must be formated this way. 

::'''Sub-account username''' : '''Sub-account Password''' @ '''VoIPmsPOP.voip.ms''' / '''Sub account username'''
<div style="margin-left:50px; 
            padding:5px; 
            font-family: Consolas, Monaco, Lucida Console, Liberation Mono, DejaVu Sans Mono, Bitstream Vera Sans Mono, Courier New, monospace;
            color: silver;
            border-left: 6px solid rgb(208, 56, 45, 0.8); 
            box-shadow: 8px 6px 9px -2px #f2f2f2;
            background-color: black; 
            width:58%;">

&nbsp;<font color="#FF00FF">######_SubAccount</font>:<font color="#F0F00F">YourSubAccountPassword</font>@<font color="#00FF00">montreal1.voip.ms</font>/<font color="#FF00FF">######_SubAccount</font>
</div>

== Inbound Route ==
== Outbound Routes ==
If you just install IncrediblePBX, you will find an outbound route named "default". You can adapt it to use the VoIP.ms route you have created. 

:'''[1]''': Go under '''Connectivity''' then '''Outbound Routes'''
:'''[2]''': Where the outbound route named '''Default''', click on the '''Edit''' button. ''(Or you can create a new Outbound route)'' 

=== Route settings tab===
:'''[1]''': '''Route Name''': You can change the name of your default route if you need. 
:'''[2]''': '''Route CID''': (Optional, you can leave it empty if you defined the caller ID directly in the trunk settings. 
:: If you want to define a specific outbound caller ID Name and Number for all outbound calls that will use this outbound route. 
:: Enter your CallerID Name and Number in the following format:
<div style="margin-left:50px; 
            padding:5px; 
            font-family: Consolas, Monaco, Lucida Console, Liberation Mono, DejaVu Sans Mono, Bitstream Vera Sans Mono, Courier New, monospace;
            color: silver;
            border-left: 6px solid rgb(208, 56, 45, 0.8); 
            box-shadow: 8px 6px 9px -2px #f2f2f2;
            background-color: black; 
            width:70%;">

&nbsp;"CALLERID NAME" <##########>
</div>
<div style="margin-left:50px; 
            padding:8px; 
            border-left: 6px solid rgb(73, 111, 199, 0.8); 
            box-shadow: 5px 4px 4px 4px #f5f5f5; 
            background-color: rgba(73, 111, 199, 0.08); 
            width:70%;">

'''⚠️ IMPORTANT - Outbound CallerID'''<br/>
* Entering outbound Caller ID Name, it must be in '''CAPITAL LETTERS'''. ''This will appears more clearly/visible on some devices.'' <br/>
* You must '''NOT use any special characters'''. ''They will not be displayed and it prevents potential outbound call issues.'' <br/>
* Do '''NOT exceed 15 characters'''. ''Traditional canadian providers will '''not show more than 15 characters'''. We suggest shrinking or adapt the name.''<br/>
* Spaces are allowed in a caller ID name but count as a characters. ''(do not exceed 15 chars. in total)''.
</div>

:'''[3]''': '''Trunk Sequence for Matched Routes''': Replace the current Trunk to the one we have edited. Eg: VoIPms-Registered. (Or then name you have entered.) Then delete the other trunks below by pressing the trash icon.

=== Dial Pattern ===

You can customize this section if you need specific rules matching your needs, such as a  '''"prefix"''' to dial out through the trunk you have selected.
:''Eg: if you enter '''9''' on prefix section'', you will need to dial 9 following the matching pattern to make the call. The prefix will be removed when it will be send to the trunk.

'''You can use the following patterns compatible for VoIPms in the colomn "[Match Pattern]"'''.

<div style="margin-left:50px; 
            padding:5px; 
            font-family: Consolas, Monaco, Lucida Console, Liberation Mono, DejaVu Sans Mono, Bitstream Vera Sans Mono, Courier New, monospace;
            color: silver;
            border-left: 6px solid rgb(208, 56, 45, 0.8); 
            box-shadow: 8px 6px 9px -2px #f2f2f2;
            background-color: black; 
            width:60%;">

{| style="background: inherit; color: silver;"
! scope=col style="text-align:left; width:25%;"   | '''MATCH PATTERN COL'''
----
! scope=col style="text-align:left;"              | ''Description''
----
|-
|<font color="#00FFFF">NXXNXXXXXX</font>  || ''(North American phone number)''
|-
|<font color="#00FFFF">1NXXNXXXXXX</font> ||''(North American phone number with country code 1)''
|-
|<font color="#00FFFF">4443</font>        || ''(Echo test)''
|-
|<font color="#00FFFF">4747</font>        || ''(DTMF test)''
|-
|<font color="#00FFFF">988</font>         || ''(Health line)''
|-
|<font color="#00FFFF">911</font>         || ''(Emergency)''
|-
|<font color="#00FFFF">822</font>         || ''(CallerID playback)''
|-
|<font color="#00FFFF">511</font>         || ''(Weather service)''
|-
|<font color="#00FFFF">411</font>         || ''(Directory assistance)''
|-
|<font color="#00FFFF">311</font>         || ''(Non-emergency)''
|-
|<font color="#00FFFF">211</font>         || ''(Municipality line)''
|-
|<font color="#00FFFF">00XX.</font>       || ''(Int. prefix, that uses the route set under the sub-account)''
|-
|<font color="#00FFFF">011XX.</font>      || '' (Int. prefix, that uses the route set under the sub-account)''
|-
|<font color="#00FFFF">033XX.</font>      || '' (Int. prefix, that will force using the <u>'''Value'''</u> route only for the call)
|-
|<font color="#00FFFF">044XX.</font>      || '' (Int. prefix, that will force using the <u>'''Premium'''</u> route only for the call)
|}
</div>


:'''[4]''': Click '''Save'''