Mercurial > prosody-modules
diff mod_post_msg/README.md @ 5975:fe081789f7b5
All community modules: Unify file extention of Markdown files to .md
| author | Menel <menel@snikket.de> |
|---|---|
| date | Tue, 22 Oct 2024 10:26:01 +0200 |
| parents | mod_post_msg/README.markdown@5e8b54deeb30 |
| children | db308d6a3b56 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mod_post_msg/README.md Tue Oct 22 10:26:01 2024 +0200 @@ -0,0 +1,79 @@ +--- +summary: 'Receives HTTP POST request, parses it and relays it into XMPP.' +--- + +Introduction +============ + +Sometimes it's useful to have different interfaces to access XMPP. + +This module allows sending XMPP +[`<message>`](https://xmpp.org/rfcs/rfc6121.html#message) stanzas via a +simple HTTP API. + +Example usage +------------- + + curl http://example.com:5280/msg/user -u me@example.com:mypassword -H "Content-Type: text/plain" -d "Server@host has just crashed!" + +This would send a message to user\@example.com from me\@example.com + +Details +======= + +URL format +---------- + + /msg/ [recipient [@host] ]. + +The base URL defaults to `/msg`. This can be configured via Prosodys +[HTTP path settings][doc:http]. + +Authentication +-------------- + +Authentication is done by HTTP Basic. + + Authentication: Basic BASE64( "username@virtualhost:password" ) + +Payload formats +--------------- + +Supported formats are: + +`text/plain` +: The HTTP body is used as plain text message payload, in the `<body>` + element. + +`application/x-www-form-urlencoded` +: Allows more fields to be specified. + +`application/json` +: Similar to form data. + +Which one is selected via the `Content-Type` HTTP header. + +### Data fields + +The form data and JSON formats allow the following fields: + +`to` +: Can be used instead of having the receiver in the URL. + +`type` +: [Message type.](https://xmpp.org/rfcs/rfc6121.html#message-syntax-type) + +`body` +: Plain text message payload which goes in the `<body>` element. + +Acknowledgements +================ + +Some code originally borrowed from mod\_webpresence + +See also +======== + +[mod_rest] is a more advanced way to send messages and more via HTTP, +with a very similar API. +