turt2live / matrix-appservice-twilio

A matrix SMS bridge, powered by Twilio

matrix-appservice-twilio

Uses Twilio to send and receive SMS messages in Matrix. Talk about it on Matrix: #sms:t2bot.io

Requirements

• NodeJS (Node 6 or higher recommended)
• A Twilio account with a phone number
• A Synapse server

Installation

Before you begin: A Synapse server is required. The instructions here assume that Synapse server is a default setup.

1. Clone this repository and install the dependencies

   git clone http://github.com/turt2live/matrix-appservice-twilio
   cd matrix-appservice-twilio
   npm install
   

2. Copy config/sample.yaml to config/config.yaml and fill in the appropriate fields

3. Generate the registration file

   node index.js -r -u "http://localhost:9000" -c config/config.yaml
   

   Note: The default URL to run the appservice is http://localhost:9000. If you have other appservices, or other requirements, pick an appropriate hostname and port.

4. Copy/symlink the registration file to your Synapse directory

   cd ~/.synapse
   ln -s ../matrix-appservice-twilio/appservice-registration-twilio.yaml appservice-registration-twilio.yaml
   

5. Add the registration file to your homeserver.yaml

   ...
   app_service_config_files: ["appservice-registration-twilio.yaml"]
   ...
   

6. Restart Synapse (synctl restart, for example)

Running

Using the port specified during the install (9000 by default), use node index.js -p 9000 -c config/config.yaml from the repository directory.

The bridge should start working shortly afterwards.

Usage

To send messages to a phone number ([phone] for example), open a conversation with @_twilio_15551234567:yourdomain.com and start chatting! All messages sent to that room will be sent via text message to the phone number. If they reply, it'll show up in the room.