The following content only applies to FreePBX and PBXact platforms

Sangoma Chat for Mobile

Owned by Kelli Higdon
Last updated: Mar 22, 2024
4 min read

 

Sangoma Chat App

 

Sangoma Chat is available for iOS in the App Store, and Android in the Google Play store.

iOS v2.5.3,

Android v2.5.4

PBX Modules

Please find below minimum module versions to fulfill the dependency requirement for Sangoma Chat for mobiles.

  • Sangoma Connect v16.0.44 (required)

    • Sangomartapi v16.0.44 (required)

    • Sysadmin v16.0.31 (required)

    • Restapps v16.0.32.12 (required)

    • Framework v16.0.26 (required)

Licensing

Your system will need to have some Softphone user licenses.  The Admin→SangomaConnect (lately renamed as the Sangoma Talk app) page will list the current number of licensed users on the PBX.

Modules

While installing or updating the required sangomartapi module, the following required modules should also get updated automatically.  Just as a reference, these are the modules that will also need to be up to date, and enabled:

  • contactmanager

  • restapps

  • sangomaconnect

  • sysadmin

  • userman

  • webrtc  

Note:  When installing the sangomartapi module from the command line, you may need to use the "downloadinstall" command if a previous version does not already exist on your system.  In this case, you might be seeing a "Cannot find module" error when using the "install" command.  If you have an existing install of the module, the "update" command should work.

fwconsole ma downloadinstall sangomartapi

 

Ports

Users will need to be able to access these system ports, which might require port forwarding for remote users.

  • Sangoma Phone Desktop Client Service (Secure Port Required) 

    • This port number will need to be given to users, because they will need to include it with the host address during login

    • This port can be set through Admin→System Admin→Port Management

  • UCP (Secure Port Recommended for remote users)

    • This is required to use the Forgot Password option from the login screen.  The UCP login page will be loaded in a web browser, which has a Forgot Password tool.  The same credentials are used for UCP and the Sangoma Chat App

  • Ports 6000-6199 - These should not need to be forwarded since they will only be used internally 

    • This range of ports should not be used for any other options set by the admin.  This is a range we are reserving the right to use for internal purposes.

    • If an admin set things up to use one of these ports before we started enforcing things, it is recommended they choose a different port

    • Ports used on your PBX

 

Advanced Settings

After the above Asterisk SIP Settings are applied, Enable the mini-HTTP Server, with TLS, and Force the WebSocket Mode to PJSIP.  These options are found in Settings→Advanced Settings.

SangomaConnect Settings

  • Set the PBX's host address in Admin→SangomaConnect→Settings

  • To avoid potential issues, the following is advised:

    • Client users will use this same Address value, along with the PBX's "Sangoma Phone Desktop Client Service" Secure Port when logging in.  With that in mind, this Address will need to be something that is resolvable from the client user's desktop.

    • A proper Fully Qualified Domain Name is recommended

    • A Secure Port must be enabled for "Sangoma Phone Desktop Client Service" in Admin→System Admin→Port Management

    • This address should also match what is used as the PBX's HTTPS SSL cert's Common Name

    • In most cases, this address should be what is found in Admin→System Admin→Hostname

User Setup

SangomaConnect Settings

  • Each Sangoma Phone user will need to be based on an existing PJSip extension.

  • In User Manager, the Sangoma Phone users will need to have "Enable Sangoma Phone Login" option enabled in the SangomaConnect tab of their user settings. 

 

Mobile App Section

Once you have the app on your mobile device, open the app and enter

  • The fully qualified domain name (meaning the hostname, not the numeric IP address) of your Freepbx followed by the Sangoma Phone Desktop Client Service port configured in here

  • Userman username

  • Userman password

 

Once you are logged in, you can:

  • Exchange text messages with your freepbx coworkers, and SMS messages with external phone numbers. This is the same Chat feature that's in the Sangoma Desktop Softphone, and you can use the clients interchangeably.

  • Place calls to your contacts using the Sangoma Talk Mobile app

  • Change your Sangoma  Status and listen to your Voicemail messages, plus see your Sangoma  Call Log and Favorite contacts.

    Status

 

Voicemail

 

Contacts

 

Call Log

 

Chat

 

Settings

 

 

Return to Documentation Home I Return to Sangoma Support