Mercurial > prosody-modules

annotate mod_voipms/README.md @ 6300:8689f49d21ef

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_voipms: Updates
author Menel <menel@snikket.de>
date Tue, 22 Jul 2025 06:24:32 +0200
parents 5cf5ee23b361
children 6015477b6dec
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6299
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
1 ---
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
2 labels:
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
3 - 'Stage-Alpha'
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
4 - 'Type-Web'
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
5 summary: Send and receive SMS/MMS via VoIP.ms APIs.
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
6 rockspec:
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
7 build:
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
8 modules:
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
9 mod_voipms: mod_voipms.lua
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
10 ...
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
11
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
12 Introduction
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
13 ============
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
14
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
15 This is a Prosody module to map JIDs to DIDs on VoIP.ms and support sending/receiving SMS/MMS.
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
16
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
17 Configuration
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
18 =============
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
19
6300
8689f49d21ef mod_voipms: Updates
Menel <menel@snikket.de>
parents: 6299
diff changeset
20 | option | type | default | description
8689f49d21ef mod_voipms: Updates
Menel <menel@snikket.de>
parents: 6299
diff changeset
21 |-----------------------|--------|---------|------------|
8689f49d21ef mod_voipms: Updates
Menel <menel@snikket.de>
parents: 6299
diff changeset
22 | voipms\_api\_username | string | nil | E-mail address used at voip.ms
8689f49d21ef mod_voipms: Updates
Menel <menel@snikket.de>
parents: 6299
diff changeset
23 | voipms\_api\_password | string | nil | API password (not login password)
8689f49d21ef mod_voipms: Updates
Menel <menel@snikket.de>
parents: 6299
diff changeset
24 | voipms\_query\_key | string | nil | Key to secure service (part of webhook)
8689f49d21ef mod_voipms: Updates
Menel <menel@snikket.de>
parents: 6299
diff changeset
25 | voipms\_jid\_map | table | nil | JID -> DIDs mapping
6299
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
26 ```
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
27 VirtualHost "sms.example.com"
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
28 modules_enabled = {
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
29 "voipms";
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
30 }
6300
8689f49d21ef mod_voipms: Updates
Menel <menel@snikket.de>
parents: 6299
diff changeset
31 voipms_api_username = john@example.com
8689f49d21ef mod_voipms: Updates
Menel <menel@snikket.de>
parents: 6299
diff changeset
32 voipms_api_password = abcd1234
8689f49d21ef mod_voipms: Updates
Menel <menel@snikket.de>
parents: 6299
diff changeset
33 voipms_query_key = some_query_key
6299
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
34 voipms_jid_map = {
6300
8689f49d21ef mod_voipms: Updates
Menel <menel@snikket.de>
parents: 6299
diff changeset
35 ["your_jid@your_domain.com"] = { "+1234567890" },
8689f49d21ef mod_voipms: Updates
Menel <menel@snikket.de>
parents: 6299
diff changeset
36 ["your_jid2@your_domain.com"] = { "+0123456789", "+18573647583" }
6299
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
37 }
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
38 ```
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
39
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
40 HTTP
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
41 ====
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
42
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
43 The module is served on Prosody's default HTTP ports at the path /voipms. More details on configuring HTTP modules in Prosody can be found in the HTTP documentation.
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
44
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
45 VoIP.ms Webhook URL
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
46 ===================
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
47
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
48 This module receives the VoIP.ms Webhook URL (POST) at the /voipms endpoint. It uses the sendSMS/sendMMS GET methods against the VoIP.ms APIs. This is an example webhook to use in VoIP.ms:
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
49
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
50 ```
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
51 https://sms.example.com/voipms?key=some_query_key
5cf5ee23b361 mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
Chaz <menel@snikket.de>
parents:
diff changeset
52 ```