diff mod_voipms/README.md @ 6300:8689f49d21ef

mod_voipms: Updates
author Menel <menel@snikket.de>
date Tue, 22 Jul 2025 06:24:32 +0200
parents 5cf5ee23b361
children 6015477b6dec
line wrap: on
line diff
--- a/mod_voipms/README.md	Mon Jul 21 23:57:37 2025 +0200
+++ b/mod_voipms/README.md	Tue Jul 22 06:24:32 2025 +0200
@@ -17,22 +17,23 @@
 Configuration
 =============
 
-| option                | type   | default |
-|-----------------------|--------|---------|
-| voipms\_api\_username | string | nil     |
-| voipms\_api\_password | string | nil     |
-| voipms\_query\_key    | string | nil     |
-| voipms\_jid\_map      | table  | nil     |
+| option                | type   | default | description
+|-----------------------|--------|---------|------------|
+| voipms\_api\_username | string | nil     | E-mail address used at voip.ms 
+| voipms\_api\_password | string | nil     | API password (not login password)
+| voipms\_query\_key    | string | nil     | Key to secure service (part of webhook)
+| voipms\_jid\_map      | table  | nil     | JID -> DIDs mapping
 ```
 VirtualHost "sms.example.com"
 modules_enabled = {
     "voipms";
 }
-voipms_api_username = john@example.com -- E-mail registered with VoIP.ms
-voipms_api_password = abcd1234 -- API password configured in VoIP.ms
-voipms_query_key = some_query_key -- query param 'key' part of your URL callback
+voipms_api_username = john@example.com
+voipms_api_password = abcd1234
+voipms_query_key = some_query_key
 voipms_jid_map = {
-        ["your_jid@your_domain.com"] = "+1234567890"
+        ["your_jid@your_domain.com"] = { "+1234567890" },
+        ["your_jid2@your_domain.com"] = { "+0123456789", "+18573647583" }
 }
 ```