FSPBX - VoIP.ms Wiki

Check out our YouTube channel to watch our simple tutorials that will help you set up most of our features.

FSPBX

From VoIP.ms Wiki

(Difference between revisions)
Jump to: navigation, search
[checked revision][checked revision]
(Created page with "FSPBX This guide explains how to configure a VoIP.ms SIP Gateway in '''FSPBX''' ''(FreeSWITCH)''. It also co...")
(→Create or Edit a Gateway)
 
(13 intermediate revisions not shown)
Line 1: Line 1:
[[File:VoIPms_FSPBX.jpg|300px|right|link=https://www.fspbx.com//|FSPBX]]
[[File:VoIPms_FSPBX.jpg|300px|right|link=https://www.fspbx.com//|FSPBX]]
-
This guide explains how to configure a VoIP.ms SIP Gateway in '''FSPBX''' ''(FreeSWITCH)''.
+
This guide explains how to configure a VoIP.ms SIP Gateway in '''FSPBX'''.  
-
 
+
-
It also covers the recommended Access Control (ACL).
+
= Requirements =
= Requirements =
Line 16: Line 14:
::* A selected VoIP.ms PoP for your DID ''(ex: montreal.voip.ms)''
::* A selected VoIP.ms PoP for your DID ''(ex: montreal.voip.ms)''
-
= Create or Edit the VoIP.ms Gateway =
+
= Create or Edit a Gateway =
-
Access your FusionPBX/FSPBX web interface:
+
Access your FSPBX web interface:
: 1) Go to '''Accounts'''
: 1) Go to '''Accounts'''
: 2) Select '''Gateways'''
: 2) Select '''Gateways'''
-
:: [[File:FreeSwitch_Account_Gateway.png|500px|none|VoIP.ms Gateway configuration screen]]
+
:: [[File:FSPBX_Account_Gateway.png|500px|none|VoIP.ms Gateway configuration screen]]
-
 
+
: 3) Click '''Create''' to create a new gateway
-
Create a new gateway (or edit an existing one) and fill in the fields exactly as shown below.
+
:: [[File:FSPBX_Account_Gateway_create.png|650px|none|VoIP.ms Gateway configuration screen]]
-
 
+
==Settings tab==
-
'''Gateway Settings'''
+
: 4) Click on the '''Settings''' tab
 +
:* '''Proxy''': Enter the your Preferred PoPServer. '' Eg: montreal1.voip.ms''
 +
:* '''Profile''': Select your profile
 +
:* '''Context''': Enter your context
 +
:* '''Register''': Select '''True'''
:* '''Username''': Enter your Sub-Account username ######_SubAccount
:* '''Username''': Enter your Sub-Account username ######_SubAccount
:* '''Password''': Enter your Sub-Account password
:* '''Password''': Enter your Sub-Account password
-
:* '''From User''': Enter your Sub-Account username ######_SubAccount
 
-
:* '''Proxy''': Enter the your Preferred PoPServer. '' Eg: montreal1.voip.ms''
 
-
:* '''Realm''': Enter "voip.ms"
 
:* '''Expire Seconds''': 120
:* '''Expire Seconds''': 120
-
:* '''Register''': Select '''True'''
 
:* '''Retry Seconds''': 30
:* '''Retry Seconds''': 30
 +
:* '''Description''': Enter a description for your note
 +
:: [[File:FSPBX_Account_Gateway_settings.png|600px|none|VoIP.ms Gateway configuration screen]]
 +
 +
==Advanced tab==
 +
: 5) Click on the '''Advanced''' tab
 +
:* '''From User''': Enter your Sub-Account username ######_SubAccount
 +
:* '''Realm''': Enter "voip.ms"
:* '''Auth Username''': Enter your Sub-Account username ######_SubAccount
:* '''Auth Username''': Enter your Sub-Account username ######_SubAccount
-
:* '''Register Transport''': udp (or TCP)
+
:* '''Register Transport''': UDP or TCP
-
:* '''SIP CID Type''': Type "rpid"
+
:* '''SIP CID Type''': Select "rpid"
:* '''Codec Preferences''': This must reflect your Sub-account, ensure you have the proper codec selected. 1
:* '''Codec Preferences''': This must reflect your Sub-account, ensure you have the proper codec selected. 1
:* '''Ping''': 20
:* '''Ping''': 20
-
:* '''Domain''': Select your demain
+
:* '''Domain''': Select your domain
-
:* '''Context''': Enter your context
+
-
:* '''Profile''': Select your profile
+
:* '''Enabled''': YES
:* '''Enabled''': YES
-
:* '''Description''': Enter a description for your note
+
:: [[File:FSPBX_Account_Gateway_advanced.png|600px|none|VoIP.ms Gateway configuration screen]]
 +
 
 +
==Provider IPs tab==
 +
: 6) Click on the '''Provider IPs''' tab
 +
::'''Note''': Adding the VoIP.ms IP ranges here automatically updates the gateway's access control list (ACL). No additional ACL configuration is required.
 +
:* Click '''[Add item]'''
 +
:* Type: 208.100.60.0/24
 +
:: [[File:FSPBX_Account_Gateway_ProviderIPs.png|600px|none|VoIP.ms Gateway configuration screen]]
 +
 
: Click '''[Save]'''
: Click '''[Save]'''
-
:: [[File:FreeSwitch_Gateway_Configuration.png|500px|none]]
 
'''Note''': Verify registration status under '''Status''' → '''Gateways / Registrations'''
'''Note''': Verify registration status under '''Status''' → '''Gateways / Registrations'''
The gateway should show Registered
The gateway should show Registered
 +
<!---------------------------
= Access Control (ACL) =
= Access Control (ACL) =
-
For better security, it is strongly recommended to restrict SIP access to VoIP.ms IP ranges only.  
+
For enhanced security, we strongly recommend restricting SIP access to VoIP.ms IP ranges only.
 +
'''Note''': If you selected '''Provider IPs''' tab while creating your Gateway, the VoIP.ms IP ranges should already be listed there.
Access the Access Control Menu
Access the Access Control Menu
:* Go to '''Advanced''' then '''Access Controls'''
:* Go to '''Advanced''' then '''Access Controls'''
-
:: [[File:FreeSwitch_access_controls_menu.png|500px|none|Advanced → Access Controls]]
+
:: [[File:FSPBX_access_controls_menu.png|500px|none|Advanced → Access Controls]]
Create or Edit the '''"providers"''' and configure the ACL as follows:
Create or Edit the '''"providers"''' and configure the ACL as follows:
Line 63: Line 75:
''Example entry:''
''Example entry:''
:* '''Type''': allow
:* '''Type''': allow
-
:* '''CIDR''': 208.100.60.0/24
+
:* '''IP/CIDR''': 208.100.60.0/24
:* '''Description''': ''Eg: "VoIP.ms POP Servers"''
:* '''Description''': ''Eg: "VoIP.ms POP Servers"''
: Click '''[Save]'''
: Click '''[Save]'''
 +
:: [[File:FSPBX_Advanced_AccessControl_editProviders.png|600px|none|Access Control – VoIP.ms IP ranges allowed]]
'''Important:'''
'''Important:'''
: VoIP.ms uses different IP ranges depending on the PoP.
: VoIP.ms uses different IP ranges depending on the PoP.
: Make sure to add all required CIDR blocks for the PoP(s) you are using.
: Make sure to add all required CIDR blocks for the PoP(s) you are using.
-
:: [[File:FreeSwitch_access_controls_IP_AllowPoP.png|500px|none|Access Control example – VoIP.ms IP ranges allowed]]
+
:: [[File:FSPBX_Advanced_AccessControl_editProviders_ipRules.png|600px|none|Access Control – VoIP.ms IP ranges allowed]]
-
 
+
----------------->
-
== Notes and Troubleshooting ==
+
= Notes and Troubleshooting =
If the gateway does not register:
If the gateway does not register:
* Double-check Username / Password / Proxy (PoP)
* Double-check Username / Password / Proxy (PoP)
Line 82: Line 95:
* Inbound Routes
* Inbound Routes
* Outbound Routes
* Outbound Routes
 +
 +
= FSPBX SMS and MMS configuration =
 +
 +
The following steps describe how to use your '''VoIP.ms''' account to deliver two-way SMS and MMS through '''FSPBX''', including inbound message handling, outbound delivery, and provider authentication. It assumes you have access to the FSPBX web interface and can edit the application environment on the server.
 +
 +
== Required environment variables ==
 +
 +
On the FSPBX host, add the following variables to your '''.env''' file:
 +
 +
'''Variable description'''
 +
:* '''VOIPMS_API_USERNAME''' – Your API username for authenticating to VoIP.ms from FSPBX. This is the '''same value as the email address''' associated with your VoIP.ms account.
 +
:* '''VOIPMS_API_PASSWORD''' – Your API password, used together with the username for secure provider access.
 +
 +
  Make sure you allowed your FSPBX IP address too.
 +
 +
== Apply configuration changes ==
 +
 +
After saving your '''.env''' file, run the following on the FSPBX server so the application loads the new settings:
 +
 +
:<code>php artisan config:cache</code>
 +
 +
== Webhook configuration ==
 +
 +
VoIP.ms delivers inbound SMS and MMS to FSPBX through a '''webhook'''. You must set the URL in the VoIP.ms customer portal so messages reach your FSPBX instance.
 +
 +
: 1) Log in to your VoIP.ms account.
 +
: 2) Go to '''DID Numbers''' → '''Manage DIDs''', then click '''Edit''' (the pencil icon) on the DID number that will receive SMS/MMS.
 +
: 3) Enable SMS/MMS on that DID if it is not already enabled.
 +
: 4) Set the '''inbound webhook URL''' to use '''POST''' with a '''JSON''' body. The path expected by FSPBX is:
 +
:: <code>https://''your-domain''/webhook/voipms/sms</code>
 +
:: Replace <code>''your-domain''</code> with the public hostname (or FQDN) of your FSPBX installation.
 +
: 5) Save your changes in the portal.
 +
 +
== Enable SMS on a DID number in FSPBX ==
 +
 +
After credentials and the webhook are in place:
 +
 +
: 1) In FSPBX, go to '''Advanced''' → '''Message Settings'''.
 +
: 2) Add or edit a number that is enabled for SMS.
 +
: 3) Select '''VoIP.ms''' as the provider.
 +
: 4) Assign the '''extension''' that should receive and send messages for that DID number.
 +
: 5) Optionally set an email address for read-only notifications.
 +
: 6) Save the configuration.
 +
 +
Resulting flow:
 +
 +
:* Inbound SMS/MMS → VoIP.ms → FSPBX → assigned extension
 +
:* Replies → FSPBX → VoIP.ms → original sender
 +
 +
== MMS support ==
 +
 +
If your DID number supports MMS, FSPBX can process media attachments through the same messaging flow. Storing MMS media in FSPBX typically requires S3-compatible storage to be configured in the system; refer to the FSPBX documentation for message storage and MMS options.
 +
 +
= Resources =
 +
 +
* [https://www.fspbx.com/docs/intro/ FSPBX – Introduction]
 +
* [https://www.fspbx.com/docs/configuration/messaging/voipms/ FSPBX – VoIP.ms SMS provider configuration]
 +
* [https://www.fspbx.com/docs/trunk-providers/voipms/ FSPBX – VoIP.ms trunk provider]

Latest revision as of 21:00, 14 October 2026

FSPBX

This guide explains how to configure a VoIP.ms SIP Gateway in FSPBX.

Contents

Requirements

Before starting, make sure you have:

  • An active VoIP.ms account
  • A Sub Account (SIP) created in the VoIP.ms portal
  • SIP Username (ex: ######_SubAccount)
  • SIP Password
  • Device Type: Asterisk, IP PBX, Gateway or VoIP Switch
  • CallerID Number: I use a system capable of passing its own CallerID
  • A selected VoIP.ms PoP for your DID (ex: montreal.voip.ms)

Create or Edit a Gateway

Access your FSPBX web interface:

1) Go to Accounts
2) Select Gateways
VoIP.ms Gateway configuration screen
3) Click Create to create a new gateway
VoIP.ms Gateway configuration screen

Settings tab

4) Click on the Settings tab
  • Proxy: Enter the your Preferred PoPServer. Eg: montreal1.voip.ms
  • Profile: Select your profile
  • Context: Enter your context
  • Register: Select True
  • Username: Enter your Sub-Account username ######_SubAccount
  • Password: Enter your Sub-Account password
  • Expire Seconds: 120
  • Retry Seconds: 30
  • Description: Enter a description for your note
VoIP.ms Gateway configuration screen

Advanced tab

5) Click on the Advanced tab
  • From User: Enter your Sub-Account username ######_SubAccount
  • Realm: Enter "voip.ms"
  • Auth Username: Enter your Sub-Account username ######_SubAccount
  • Register Transport: UDP or TCP
  • SIP CID Type: Select "rpid"
  • Codec Preferences: This must reflect your Sub-account, ensure you have the proper codec selected. 1
  • Ping: 20
  • Domain: Select your domain
  • Enabled: YES
VoIP.ms Gateway configuration screen

Provider IPs tab

6) Click on the Provider IPs tab
Note: Adding the VoIP.ms IP ranges here automatically updates the gateway's access control list (ACL). No additional ACL configuration is required.
  • Click [Add item]
  • Type: 208.100.60.0/24
VoIP.ms Gateway configuration screen
Click [Save]

Note: Verify registration status under Status → Gateways / Registrations The gateway should show Registered

Notes and Troubleshooting

If the gateway does not register:

  • Double-check Username / Password / Proxy (PoP)
  • Ensure firewall and NAT allow UDP 5060 and RTP traffic
  • Confirm your ACL includes the correct VoIP.ms IP ranges

Inbound and outbound call routing is configured separately using:

  • Dialplans
  • Inbound Routes
  • Outbound Routes

FSPBX SMS and MMS configuration

The following steps describe how to use your VoIP.ms account to deliver two-way SMS and MMS through FSPBX, including inbound message handling, outbound delivery, and provider authentication. It assumes you have access to the FSPBX web interface and can edit the application environment on the server.

Required environment variables

On the FSPBX host, add the following variables to your .env file:

Variable description

  • VOIPMS_API_USERNAME – Your API username for authenticating to VoIP.ms from FSPBX. This is the same value as the email address associated with your VoIP.ms account.
  • VOIPMS_API_PASSWORD – Your API password, used together with the username for secure provider access. 
 Make sure you allowed your FSPBX IP address too.

Apply configuration changes

After saving your .env file, run the following on the FSPBX server so the application loads the new settings:

php artisan config:cache

Webhook configuration

VoIP.ms delivers inbound SMS and MMS to FSPBX through a webhook. You must set the URL in the VoIP.ms customer portal so messages reach your FSPBX instance.

1) Log in to your VoIP.ms account.
2) Go to DID Numbers → Manage DIDs, then click Edit (the pencil icon) on the DID number that will receive SMS/MMS.
3) Enable SMS/MMS on that DID if it is not already enabled.
4) Set the inbound webhook URL to use POST with a JSON body. The path expected by FSPBX is:
https://your-domain/webhook/voipms/sms
Replace your-domain with the public hostname (or FQDN) of your FSPBX installation.
5) Save your changes in the portal.

Enable SMS on a DID number in FSPBX

After credentials and the webhook are in place:

1) In FSPBX, go to Advanced → Message Settings.
2) Add or edit a number that is enabled for SMS.
3) Select VoIP.ms as the provider.
4) Assign the extension that should receive and send messages for that DID number.
5) Optionally set an email address for read-only notifications.
6) Save the configuration.

Resulting flow:

  • Inbound SMS/MMS → VoIP.ms → FSPBX → assigned extension
  • Replies → FSPBX → VoIP.ms → original sender

MMS support

If your DID number supports MMS, FSPBX can process media attachments through the same messaging flow. Storing MMS media in FSPBX typically requires S3-compatible storage to be configured in the system; refer to the FSPBX documentation for message storage and MMS options.

Resources

Retrieved from "https://wiki.voip.ms/article/FSPBX"
Personal tools
Namespaces
Variants
Actions
VoIP.ms Wiki
Guides 🇨🇦
Guías 🇲🇽