Giter Site home page Giter Site logo

treethought / matrix-pulsesms Goto Github PK

View Code? Open in Web Editor NEW
4.0 3.0 1.0 6.16 MB

matrix bridge for pulsesms

License: GNU Affero General Public License v3.0

Dockerfile 0.21% Go 99.33% Shell 0.33% Makefile 0.14%
matrix bridge appservice sms pulsesms

matrix-pulsesms's Introduction

matrix-pulsesms

A mautrix-style matrix bridge for PulseSMS

This bridge is a fork of the excellent mautrix-whatsapp created by Tulir Asokan. All credit for design and heavy lifting of this bridge belongs to him.

Overview

While there are other options for bridging SMS SmsMatrix and matrix-sms-bridge, they require either an SMS gateway server, or a dedicated app running alongside your sms app to work.

matrix-pulsesms instead uses the cross-device syncing capability and API of PulseSMS and serves as a bridge by acting as pulse API client.

While this has some benefits over the other bridges (no gateway needed, and no dediciated app running in the background), there are some drawbacks and things to be aware of:

  • you will need a cloud account / subscription with PulseSMS
  • your messages will be stored in the cloud by PulseSMS, however everything is end-to-end encrypted
  • The PulseSMS API is not officially supported or documented, so there may be some issues.
  • I have found that occasionally, messages will be successfully sent to PulseSMS and appear on other devices, but are not sent as SMS on the primary (phone) device. This can usually be fixed by force quitting the app or restarting your device

Usage

After registering the appservice, send a message to @pulsebot:domain. You can the send help to see a list of commands.

To begin bridging

  • login by sending login [email protected] pulsesmspassword 15555555555, replacing your email, password, and phone number (prefixed with 1)
  • if you enabled the usage of a Space, the bot will invite you to the newly created PulseSMS space
  • you will then see invites from your most recent conversations.
  • Each contact is puppetted in matrix with an mxid of @pulse_PHONENUMBER:domain
  • pulsebot will invite your matrix user and the puppets that are members for each chat
  • SMS conversations with a single contact will be created as direct messages in matrix
  • Group SMS conversations will be created as rooms in matrix

Features

After logging in and performing

  • syncing of contacts
  • backfilling of history on sync
  • SMS for direct chats
  • SMS for group chats
  • handling of messages from new contacts
  • MMS / media messages
  • Syncing of Read/Seen status

matrix-pulsesms's People

Contributors

14mrh4x0r avatar anoadragon453 avatar conor-f avatar deepbluev7 avatar dekedro avatar dereisele avatar emilylange avatar hramirezf avatar izissise avatar jo-so avatar krombel avatar lieuwex avatar mawalu avatar myii avatar olmari avatar pastudan avatar progserega avatar pwr22 avatar rafaeltheraven avatar rennerdo30 avatar rreuvekamp avatar surakin avatar treethought avatar tulir avatar zopieux avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

yawks

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.