Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/agwa/sms-over-xmpp
XMPP Component (XEP-0114) to send and receive SMS
https://github.com/agwa/sms-over-xmpp
go sms twilio xmpp-component
Last synced: 10 days ago
JSON representation
XMPP Component (XEP-0114) to send and receive SMS
- Host: GitHub
- URL: https://github.com/agwa/sms-over-xmpp
- Owner: AGWA
- License: other
- Created: 2017-01-30T19:16:00.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-07-09T21:17:26.000Z (over 1 year ago)
- Last Synced: 2024-10-15T10:52:08.790Z (22 days ago)
- Topics: go, sms, twilio, xmpp-component
- Language: Go
- Size: 148 KB
- Stars: 77
- Watchers: 15
- Forks: 10
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SMS-over-XMPP
sms-over-xmpp is an XMPP component (XEP-0114) that acts as a gateway
between an XMPP (aka Jabber) network and the SMS network. It allows
you to send and receive SMS messages as if they were XMPP messages,
using your favorite XMPP client.
You send an XMPP message and your friend receives an SMS. When they
send you an SMS, you receive an XMPP message.
## Supported SMS Providers
* Twilio (recommended)
* Nexmo/Vonage
* Signalwire
## Features
### MMS
sms-over-xmpp can send and receive MMS messages containing images.
To send MMS, your XMPP client/server must support:
* XEP-0363 (HTTP File Upload)
* XEP-0066 (Out of Band Data)
To receive MMS, your XMPP client must support:
* XEP-0066 (Out of Band Data)
If your client does not support XEP-0066, then incoming MMS will
contain a URL to the media file.
### CardDAV Roster Synchronization
sms-over-xmpp can optionally synchronize a CardDAV address book with your
XMPP roster. Any contact in your address book with a mobile phone number
is added to your XMPP roster with the necessary address to send them
an SMS. When a contact is deleted, it is also deleted from your roster.
The synchronization is one-way: changes made to your XMPP roster aren't
propagated to your address book, and may be reverted.
Your XMPP server must support
[XEP-0321](https://xmpp.org/extensions/xep-0321.html). For Prosody,
you can use [mod_remote_roster](https://modules.prosody.im/mod_remote_roster.html). (Make
sure you use a version which incorporates [this commit](https://hg.prosody.im/prosody-modules/rev/ad6e9b0fd15b).)
## Installing
If you have the latest version of Go installed, you can run:
```
go install src.agwa.name/sms-over-xmpp/cmd/sms-over-xmpp@latest
```
Or, you can download a binary from the [GitHub Releases Page](https://github.com/AGWA/sms-over-xmpp/releases).
sms-over-xmpp is a single statically-linked binary so using Docker or a similar technology is superfluous.
## Configuring
See the [Config Reference](doc/configuration.md).
## Tested Configurations
sms-over-xmpp has been tested with the following configuration:
* [Twilio](https://www.twilio.com/) for the SMS provider
* [Prosody](https://prosody.im/) for the XMPP server
* [Gajim](https://gajim.org/) for the desktop XMPP client
* [Monal](https://monal.im/) for the mobile (iOS) XMPP client
* [Radicale](https://radicale.org/) for the CardDAV server (needed for address book synchronization)
* [mod_http_upload_s3](https://github.com/abeluck/mod_http_upload_s3) for HTTP file upload in Prosody (needed for sending MMS)
* [mod_remote_roster](https://modules.prosody.im/mod_remote_roster.html) for remote roster management in Prosody (needed for address book synchronization)