From VoIP.ms Wiki

[checked revision]

[checked revision]

Revision as of 07:00, 27 February 2024 (view source) Scomtois (Talk | contribs) (→Incoming) ← Older edit		Revision as of 08:29, 27 February 2024 (view source) Scomtois (Talk | contribs) (→Outbound Routes) Newer edit →
Line 123:		Line 123:
	=== Route settings ===		=== Route settings ===
	:'''[1]''': '''Route Name''': You can change the name of your default route if you need.		:'''[1]''': '''Route Name''': You can change the name of your default route if you need.
-	:'''[2]''': '''Route CID''':	+	:'''[2]''': '''Route CID''': (Optional, you can leave it empty if you defined the caller ID directly in the trunk settings.
-	:'''[3]''': '''Route Name''':	+	:: If you want to define a specific outbound caller ID Name and Number for all outbound calls that will use this outbound route.
-	:'''[4]''': '''Route Name''':	+	:: Enter your CallerID Name and Number in the following format:
-	:'''[5]''': '''Route Name''':	+	<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 customise this section if you need specific rules matching your needs, such as a  '''"prefix"''' to dial out. Eg: if you place '''9''' on prefix	+	You can customize this section if you need specific rules matching your needs, such as a  '''"prefix"''' to dial out. ''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.
-	We suggest adding some of our feature code in order to test the service.	+
		+	If you dont know the exact pattern to enter, we suggest adding the following dial pattern and feature code.
	: '''You can use the following characters:'''		: '''You can use the following characters:'''
Line 135:		Line 162:
	:* '''"Z"''': For numbers from 1 to 9		:* '''"Z"''': For numbers from 1 to 9
	:* '''"N"''': For numbers from 2 to 9		:* '''"N"''': For numbers from 2 to 9
-	:* '''“.”''': (dot) Stands for one or more digits	+	:* '''"."''': (dot) Stands for one or more digits
-	:* '''“!”''': (exclamation mark) Stands for zero or more digits	+	:* '''"!"''': (exclamation mark) Stands for zero or more digits
	: '''You can also use square brackets:'''		: '''You can also use square brackets:'''
Line 155:		Line 182:
	: NXXNXXXXXX		: NXXNXXXXXX
	: 1NXXNXXXXXX		: 1NXXNXXXXXX
-	: 4443	+	: 4443 (Echo test)
-	: 4747	+	: 4747 (DTMF test)
-	: 988	+	: 988 (Health line)
-	: 911	+	: 911 (Emergency)
-	: 822	+	: 822 (CallerID playback)
-	: 511	+	: 511 (Weather service)
-	: 411	+	: 411 (Directory assistance)
-	: 311	+	: 311 (Non-emergency)
-	: 211	+	: 211 (Municipality line)
-	: 011XX.	+	: 011XX. (International prefix, that use the route set under the sub-account)
-	: 033XX.	+	: 033XX. (International prefix, that will force using the Value route only for the call)
-	: 044XX.	+	: 044XX. (International prefix, that will force using the Premium route only for the call)
	</div>		</div>

---

Revision as of 08:29, 27 February 2024

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®.

Contents 1 Pre-requisites 1.1 Sub-Account (Trunk) 2 Trunk Configuration 2.1 General Tab 2.2 Dial Number Manipulation Rules Tab 2.3 sip Settings Tab 2.3.1 Outgoing 2.3.2 Incoming 2.4 Inbound Route 2.5 Outbound Routes 2.5.1 Route settings 2.6 Dial Pattern

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:

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

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

Inbound Route

Outbound Routes

If you just install IncrediblePBX, you will find a default outbound route. You can adapt it to use the VoIP.ms route you have created.

[1]: Go under Connectivity then Outbound Routes

[2]: Where the Default outbound route, click on the Edit button.

Route settings

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

[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. 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.

If you dont know the exact pattern to enter, we suggest adding the following dial pattern and feature code.

You can use the following characters:

• "X": Corresponds to numbers from 0 to 9
• "Z": For numbers from 1 to 9
• "N": For numbers from 2 to 9
• ".": (dot) Stands for one or more digits
• "!": (exclamation mark) Stands for zero or more digits

You can also use square brackets:

• [1-5] Corresponds to numbers from 1 to 5.
• [123] Corresponds to numbers 1, 2 or 3.

You can use the predefined patterns compatible for VoIPms