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)

local http = require "net.http";
local json = require "util.json";
local st = require "util.stanza";
local xml = require "util.xml";
local unpack = rawget(_G, "unpack") or table.unpack;

local url = module:get_option_string("component_post_url");
assert(url, "Missing required config option 'component_post_url'");

local stanza_kinds = module:get_option_set("post_stanza_types", { "message" });

local http_error_map = {
	[0]   = { "cancel", "remote-server-timeout", "Connection failure" };
	-- 4xx
	[400] = { "modify", "bad-request" };
	[401] = { "auth", "not-authorized" };
	[402] = { "auth", "forbidden", "Payment required" };
	[403] = { "auth", "forbidden" };
	[404] = { "cancel", "item-not-found" };
	[410] = { "cancel", "gone" };
	-- 5xx
	[500] = { "cancel", "internal-server-error" };
	[501] = { "cancel", "feature-not-implemented" };
	[502] = { "cancel", "remote-server-timeout", "Bad gateway" };
	[503] = { "wait", "remote-server-timeout", "Service temporarily unavailable" };
	[504] = { "wait", "remote-server-timeout", "Gateway timeout" };
}

local function error_reply(stanza, code)
	local error = http_error_map[code] or { "cancel", "service-unavailable" };
	return st.error_reply(stanza, unpack(error, 1, 3));
end

function handle_stanza(event)
	local stanza = event.stanza;
	local request_body = json.encode({
		to = stanza.attr.to;
		from = stanza.attr.from;
		kind = stanza.name;
		body = stanza.name == "message" and stanza:get_child_text("body") or nil;
		stanza = tostring(stanza);
	});
	http.request(url, {
		body = request_body;
	}, function (response_text, code, response)
		if stanza.attr.type == "error" then return; end -- Avoid error loops, don't reply to error stanzas
		if code == 200 and response_text and response.headers["content-type"] == "application/json" then
			local response_data = json.decode(response_text);
			if response_data.stanza then
				local reply_stanza = xml.parse(response_data.stanza);
				if reply_stanza then
					reply_stanza.attr.from, reply_stanza.attr.to = stanza.attr.to, stanza.attr.from;
					module:send(reply_stanza);
				else
					module:log("warn", "Unable to parse reply stanza");
				end
			else
				local stanza_kind = response_data.kind or "message";
				local to = response_data.to or stanza.attr.from;
				local from = response_data.from or stanza.attr.to;
				local reply_stanza = st.stanza(stanza_kind, {
					to = to, from = from;
					type = response_data.type or (stanza_kind == "message" and "chat") or nil;
				});
				if stanza_kind == "message" and response_data.body then
					reply_stanza:tag("body"):text(tostring(response_data.body)):up();
				end
				module:log("debug", "Sending %s", tostring(reply_stanza));
				module:send(reply_stanza);
			end
		elseif code >= 200 and code <= 299 then
			return;
		else
			module:send(error_reply(stanza, code));
		end
		return true;
	end);
	return true;
end

for stanza_kind in stanza_kinds do
	for _, jid_type in ipairs({ "host", "bare", "full" }) do
		module:hook(stanza_kind.."/"..jid_type, handle_stanza);
	end
end

-- Simple handler for an always-online JID that allows everyone to subscribe to presence
local function default_presence_handler(event)
	local stanza = event.stanza;
	module:log("debug", "Handling %s", tostring(stanza));
	if stanza.attr.type == "probe" then
		module:send(st.presence({ to = stanza.attr.from, from = stanza.attr.to.."/default" }));
	elseif stanza.attr.type == "subscribe" then
		module:send(st.presence({ type = "subscribed", to = stanza.attr.from, from = stanza.attr.to.."/default" }));
		module:send(st.presence({ to = stanza.attr.from, from = stanza.attr.to.."/default" }));
	elseif stanza.attr.type == "unsubscribe" then
		module:send(st.presence({ type = "unavailable", to = stanza.attr.from, from = stanza.attr.to.."/default" }));
	end
	return true;
end

module:hook("presence/bare", default_presence_handler, -1);