Call Us Today! 877.742.2583




Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.



Expand
titleTable of Contents (click to expand)


Panel
borderStyledashed

Table of Contents



0. About

Allows external service connections to SignalWire telecommunications provider via integrations, formerly known as connectors. See the official connector product description for more info.  

Info

Enabled by default in modules.conf.xml for vanilla installations.

Supported services:

  • SignalWire STACK
  • FreeSWITCH
  • Agora
  • Zapier
Expand
titleTable of Contents
Panel
borderStyledashed

Table of Contents

Capabilities

1. Capabilities

Enables several valuable functions that will automate configuration and connect services. Without any additional configuration in the FreeSWITCH instance, FreeSWITCH can be connected to SignalWire CLOUD. When doing so the FreeSWITCH configuration will be automagically modified based on what CLOUD services are assembled under the Integration.

  • Voice
    Voice resources including DIDs, Toll Free numbers can be purchased through CLOUD and directed to your FreeSWITCH Integration, which will automatically configure your FreeSWITCH instance to work with the Voice resources.

  • Messaging
    Not yet available.

2. Components

2.1 mod_signalwire

This is official SignalWire module is part of FreeSWITCH v1.8.3 and later (check Release Notes) and STACK v 20.18.2 which can be obtained from SignalWire STACK repositories. Contact SignalWire Sales (sales@signalwire.com) for more information. mod_signalwire installs as part of the default package and windows installs, and will loaded by default on new installs. See below for installation / loading instructions on existing installations.

2.2 SignalWire CLOUD Resources

The CLOUD APIs and dashboard can be used together to enable a FreeSWITCH Integration for voice. The intuitive dashboard will allow users to create the Integration that is associated with your FreeSWITCH instance. APIs take it to another level and allow for quite a bit of flexibility.

2.3 CLOUD APIs

SignalWire Cloud APIs are defined here: https://docs.signalwire.com/

RELAY APIs can be found here: https://docs.signalwire.com/relay-rest/

2.4 CLOUD Integration UI/UX

Go to Integrations in your SignalWire Dashboard.

3. Connect to SignalWire by creating a new Integration/Connector

Note
titleOnly from FreeSWITCH 1.8.3

You will need to be running at least FreeSWITCH 1.8.3, or STACK 20.18.2 in order to load the SignalWire module.

...

and, depending on your use case, choose "Voice Calls" or "Fax" at "HANDLE INCOMING CALLS AS", select "a FreeSwitch Connector" at "HANDLE CALLS USING", and finally, select the connector that you desire.

4. Dialplan sample

Code Block
languagexml
title/etc/freeswitch/dialplan/default.xml (for example)
    <extension name="SignalWire INTEGRATIONS incoming call">
      <condition field="destination_number" expression="^(\+18005551212)$"> <!-- the number you assigned in your dashboard -->
        <action application="bridge" data="user/1000"/>
      </condition>
    </extension>

    <extension name="signalwire INTEGRATIONS outgoing call">
      <condition field="destination_number" expression="^(\+?\d{11})$">
        <action application="answer"/>
        <action application="bridge" data="sofia/gateway/signalwire/$1"/>
      </condition>
    </extension>

5. Location of mod_signalwire configuration

mod_signalwire configuration settings are saved in memory of the FreeSWITCH instance, but they are also cached in the storage directory, in case it can't connect to SignalWire CLOUD on restart.

...