Mercurial > prosody-modules

view mod_pubsub_forgejo/webhook-examples/push/content.json @ 6299:5cf5ee23b361

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs. diff --git a/mod_voipms/README.md b/mod_voipms/README.md new file mode 100644 --- /dev/null +++ b/mod_voipms/README.md @@ -0,0 +1,51 @@ +--- +labels: +- 'Stage-Alpha' +- 'Type-Web' +summary: Send and receive SMS/MMS via VoIP.ms APIs. +rockspec: + build: + modules: + mod_voipms: mod_voipms.lua +... + +Introduction +============ + +This is a Prosody module to map JIDs to DIDs on VoIP.ms and support sending/receiving SMS/MMS. + +Configuration +============= + +| option | type | default | +|-----------------------|--------|---------| +| voipms\_api\_username | string | nil | +| voipms\_api\_password | string | nil | +| voipms\_query\_key | string | nil | +| voipms\_jid\_map | table | nil | +``` +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_jid_map = { + ["your_jid@your_domain.com"] = "+1234567890" +} +``` + +HTTP +==== + +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. + +VoIP.ms Webhook URL +=================== + +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: + +``` +https://sms.example.com/voipms?key=some_query_key +``` diff --git a/mod_voipms/mod_voipms.lua b/mod_voipms/mod_voipms.lua new file mode 100644 --- /dev/null +++ b/mod_voipms/mod_voipms.lua @@ -0,0 +1,166 @@ +local http = require "net.http" +local json = require "util.json" +local st = require "util.stanza" + +local api_username = module:get_option_string("voipms_api_username") +local api_password = module:get_option_string("voipms_api_password") +local query_key = module:get_option("voipms_query_key") +local jid_map = module:get_option("voipms_jid_map") or {} +local rest_endpoint = "https://voip.ms/api/v1/rest.php" + +if not api_username or not api_password or not query_key then + module:log("error", "Missing required config values (voipms_api_username, voipms_api_password, voipms_query_key)") + return +end + +module:depends("http") + +local function normalize_number(num) + if not num then return nil end + if num:sub(1, 1) ~= "+" then + return "+1" .. num + end + return num +end + +local function extract_query_key(event) + return (event.request.url.query or ""):match("key=([^&]+)") +end + +module:provides("http", { + route = { + ["POST"] = function(event) + local req = event.request + local body = req.body or "" + + if extract_query_key(event) ~= query_key then + module:log("warn", "Unauthorized webhook: missing or invalid key") + return { status_code = 403 } + end + + local json_payload, err = json.decode(body) + if not json_payload then + module:log("warn", "Invalid JSON: %s", err or "unknown error") + return { status_code = 400 } + end + + local payload = json_payload.data and json_payload.data.payload + if not payload then + module:log("warn", "Missing payload in JSON") + return { status_code = 400 } + end + + local from = payload.from and payload.from.phone_number + local to_list = payload.to or {} + local to = #to_list > 0 and to_list[1].phone_number or nil + + if not from or not to then + module:log("warn", "Missing phone numbers (from: %s, to: %s)", tostring(from), tostring(to)) + return { status_code = 400 } + end + + local normalized_to = normalize_number(to) + local target_jid = nil + + for jid, did in pairs(jid_map) do + if normalize_number(did) == normalized_to then + target_jid = jid + break + end + end + + if not target_jid then + module:log("warn", "No JID mapping for DID %s", normalized_to) + return { status_code = 404 } + end + + local normalized_from = normalize_number(from) + local message_text = payload.text or "" + + local message = st.message({ + from = normalized_from .. "@" .. module.host, + to = target_jid, + type = "chat" + }):tag("body"):text(message_text):up() + + if payload.media and #payload.media > 0 then + for _, media_item in ipairs(payload.media) do + if media_item.url then + message_text = message_text .. "\n" .. media_item.url + message:tag("x", { xmlns = "jabber:x:oob" }) + :tag("url"):text(media_item.url):up():up() + end + end + end + + module:send(message) + module:log("info", "Delivered SMS from %s to %s", normalized_from, target_jid) + + return { status_code = 204 } + end + } +}) + +module:hook("message/bare", function(event) + local stanza = event.stanza + if stanza.attr.type ~= "chat" then return end + + local from_jid = stanza.attr.from + local to_jid = stanza.attr.to + local body = stanza:get_child_text("body") + if not body or body == "" then return end + + local from_number = jid_map[from_jid] + if not from_number then + module:log("warn", "No DID mapping for JID %s", from_jid) + return + end + + local to_number = to_jid:match("^([^@]+)") + if not to_number then + module:log("warn", "Malformed JID in message.to: %s", to_jid) + return + end + + to_number = normalize_number(to_number) + + local media_urls = {} + for line in body:gmatch("[^\r\n]+") do + if line:match("^https?://") then + table.insert(media_urls, line) + end + end + + local method = (#media_urls > 0) and "sendMMS" or "sendSMS" + local query = { + api_username = api_username, + api_password = api_password, + method = method, + did = from_number, + dst = to_number, + message = body + } + + if method == "sendMMS" then + for i, url in ipairs(media_urls) do + query["media_url[" .. (i - 1) .. "]"] = url + end + end + + local query_str = http.formencode(query) + + http.request(rest_endpoint .. "?" .. query_str, { + method = "GET"; + }, function(response_body, code) + if code == 200 then + local resp, err = json.decode(response_body) + if not resp or resp.status ~= "success" then + module:log("error", "Failed to send %s: %s", method, err or (resp and resp.status) or "unknown") + else + module:log("info", "Sent %s from %s to %s", method, from_number, to_number) + end + else + module:log("error", "HTTP error sending %s: code %s", method, tostring(code)) + end + end) +end)
author Chaz <menel@snikket.de>
date Mon, 21 Jul 2025 23:57:37 +0200
parents 131b8bfbefb4
children
line wrap: on
line source

{
  "ref": "refs/heads/dev",
  "before": "3f8b7a2f69c6c891d8ab07700f113103db73faa3",
  "after": "dd7c6923c788b38312fbc27cffba3b7007d0126e",
  "compare_url": "https://codeberg.org/slidge/slidgram/compare/3f8b7a2f69c6c891d8ab07700f113103db73faa3...dd7c6923c788b38312fbc27cffba3b7007d0126e",
  "commits": [
    {
      "id": "dd7c6923c788b38312fbc27cffba3b7007d0126e",
      "message": "build: update pre-commit hooks\n",
      "url": "https://codeberg.org/slidge/slidgram/commit/dd7c6923c788b38312fbc27cffba3b7007d0126e",
      "author": {
        "name": "nicoco",
        "email": "nicoco@nicoco.fr",
        "username": "nicoco"
      },
      "committer": {
        "name": "nicoco",
        "email": "nicoco@nicoco.fr",
        "username": "nicoco"
      },
      "verification": null,
      "timestamp": "2025-01-16T13:33:08+01:00",
      "added": [],
      "removed": [],
      "modified": [
        ".pre-commit-config.yaml"
      ]
    },
    {
      "id": "790116333966f395cc268b032c7a6173486955f4",
      "message": "chore: update lockfile\n\nbecause we must",
      "url": "https://codeberg.org/slidge/slidgram/commit/790116333966f395cc268b032c7a6173486955f4",
      "author": {
        "name": "nicoco",
        "email": "nicoco@nicoco.fr",
        "username": "nicoco"
      },
      "committer": {
        "name": "nicoco",
        "email": "nicoco@nicoco.fr",
        "username": "nicoco"
      },
      "verification": null,
      "timestamp": "2025-01-13T15:47:16+01:00",
      "added": [
        "uv.lock"
      ],
      "removed": [],
      "modified": []
    },
    {
      "id": "776de82113f8a860408f78c22e8539e73306ac87",
      "message": "ci: use woodpecker\n",
      "url": "https://codeberg.org/slidge/slidgram/commit/776de82113f8a860408f78c22e8539e73306ac87",
      "author": {
        "name": "nicoco",
        "email": "nicoco@nicoco.fr",
        "username": "nicoco"
      },
      "committer": {
        "name": "nicoco",
        "email": "nicoco@nicoco.fr",
        "username": "nicoco"
      },
      "verification": null,
      "timestamp": "2025-01-11T15:57:59+01:00",
      "added": [
        ".woodpecker/container-ci.yaml",
        ".woodpecker/container.yaml",
        ".woodpecker/docs.yaml",
        ".woodpecker/package.yaml",
        ".woodpecker/test.yaml"
      ],
      "removed": [
        ".builds/ci.yml",
        ".builds/container.yml",
        ".copier-answers.yml"
      ],
      "modified": [
        ".gitignore",
        "Dockerfile",
        "README.md",
        "docs/Makefile",
        "docs/source/conf.py",
        "pyproject.toml"
      ]
    }
  ],
  "total_commits": 3,
  "head_commit": {
    "id": "dd7c6923c788b38312fbc27cffba3b7007d0126e",
    "message": "build: update pre-commit hooks\n",
    "url": "https://codeberg.org/slidge/slidgram/commit/dd7c6923c788b38312fbc27cffba3b7007d0126e",
    "author": {
      "name": "nicoco",
      "email": "nicoco@nicoco.fr",
      "username": "nicoco"
    },
    "committer": {
      "name": "nicoco",
      "email": "nicoco@nicoco.fr",
      "username": "nicoco"
    },
    "verification": null,
    "timestamp": "2025-01-16T13:33:08+01:00",
    "added": [],
    "removed": [],
    "modified": [
      ".pre-commit-config.yaml"
    ]
  },
  "repository": {
    "id": 301703,
    "owner": {
      "id": 205842,
      "login": "slidge",
      "login_name": "",
      "source_id": 0,
      "full_name": "",
      "email": "",
      "avatar_url": "https://codeberg.org/avatars/aa0eeeb5fe173938bdc665be92bf605efa1e8f4a905bc3327e4d5c7eddf584e5",
      "html_url": "https://codeberg.org/slidge",
      "language": "",
      "is_admin": false,
      "last_login": "0001-01-01T00:00:00Z",
      "created": "2024-08-30T14:16:14Z",
      "restricted": false,
      "active": false,
      "prohibit_login": false,
      "location": "",
      "pronouns": "",
      "website": "https://slidge.im",
      "description": "",
      "visibility": "public",
      "followers_count": 3,
      "following_count": 0,
      "starred_repos_count": 0,
      "username": "slidge"
    },
    "name": "slidgram",
    "full_name": "slidge/slidgram",
    "description": "A feature-rich Telegram to XMPP gateway",
    "empty": false,
    "private": false,
    "fork": false,
    "template": false,
    "parent": null,
    "mirror": false,
    "size": 1561,
    "language": "",
    "languages_url": "https://codeberg.org/api/v1/repos/slidge/slidgram/languages",
    "html_url": "https://codeberg.org/slidge/slidgram",
    "url": "https://codeberg.org/api/v1/repos/slidge/slidgram",
    "link": "",
    "ssh_url": "git@codeberg.org:slidge/slidgram.git",
    "clone_url": "https://codeberg.org/slidge/slidgram.git",
    "original_url": "",
    "website": "",
    "stars_count": 0,
    "forks_count": 1,
    "watchers_count": 3,
    "open_issues_count": 7,
    "open_pr_counter": 0,
    "release_counter": 0,
    "default_branch": "main",
    "archived": false,
    "created_at": "2025-01-10T09:19:40Z",
    "updated_at": "2025-01-16T12:15:22Z",
    "archived_at": "1970-01-01T00:00:00Z",
    "permissions": {
      "admin": true,
      "push": true,
      "pull": true
    },
    "has_issues": true,
    "internal_tracker": {
      "enable_time_tracker": true,
      "allow_only_contributors_to_track_time": true,
      "enable_issue_dependencies": true
    },
    "has_wiki": false,
    "wiki_branch": "main",
    "globally_editable_wiki": false,
    "has_pull_requests": true,
    "has_projects": false,
    "has_releases": true,
    "has_packages": true,
    "has_actions": false,
    "ignore_whitespace_conflicts": false,
    "allow_merge_commits": true,
    "allow_rebase": true,
    "allow_rebase_explicit": true,
    "allow_squash_merge": true,
    "allow_fast_forward_only_merge": true,
    "allow_rebase_update": true,
    "default_delete_branch_after_merge": false,
    "default_merge_style": "merge",
    "default_allow_maintainer_edit": false,
    "avatar_url": "",
    "internal": false,
    "mirror_interval": "",
    "object_format_name": "sha1",
    "mirror_updated": "0001-01-01T00:00:00Z",
    "repo_transfer": null,
    "topics": [
      "bridge",
      "chat",
      "gateway",
      "instant-messaging",
      "slidge",
      "telegram",
      "telegram-userbot",
      "xmpp"
    ]
  },
  "pusher": {
    "id": 64076,
    "login": "nicoco",
    "login_name": "",
    "source_id": 0,
    "full_name": "",
    "email": "nicoco@noreply.codeberg.org",
    "avatar_url": "https://codeberg.org/avatars/32a918ca7a66e4e484ee2ccc625dc6451da728355c060ed0ed54fa69d89224a5",
    "html_url": "https://codeberg.org/nicoco",
    "language": "",
    "is_admin": false,
    "last_login": "0001-01-01T00:00:00Z",
    "created": "2022-09-12T11:13:13Z",
    "restricted": false,
    "active": false,
    "prohibit_login": false,
    "location": "Nice, France",
    "pronouns": "",
    "website": "https://nicoco.fr",
    "description": "wannabe-hacker",
    "visibility": "public",
    "followers_count": 1,
    "following_count": 0,
    "starred_repos_count": 3,
    "username": "nicoco"
  },
  "sender": {
    "id": 64076,
    "login": "nicoco",
    "login_name": "",
    "source_id": 0,
    "full_name": "",
    "email": "nicoco@noreply.codeberg.org",
    "avatar_url": "https://codeberg.org/avatars/32a918ca7a66e4e484ee2ccc625dc6451da728355c060ed0ed54fa69d89224a5",
    "html_url": "https://codeberg.org/nicoco",
    "language": "",
    "is_admin": false,
    "last_login": "0001-01-01T00:00:00Z",
    "created": "2022-09-12T11:13:13Z",
    "restricted": false,
    "active": false,
    "prohibit_login": false,
    "location": "Nice, France",
    "pronouns": "",
    "website": "https://nicoco.fr",
    "description": "wannabe-hacker",
    "visibility": "public",
    "followers_count": 1,
    "following_count": 0,
    "starred_repos_count": 3,
    "username": "nicoco"
  }
}