File

mod_muc_bot/README.markdown @ 5519:83ebfc367169

mod_http_oauth2: Return Authentication Time per OpenID Core Section 2 Mandatory To Implement, either MUST include or OPTIONAL depending on things we don't look at, so might as well include it all the time. Since we do not persist authentication state with cookies or such, the authentication time will always be some point between the user being sent to the authorization endpoint and the time they are sent back to the client application.
author Kim Alvefur <zash@zash.se>
date Mon, 05 Jun 2023 22:32:44 +0200
parent 5011:55cf7f063af6
line wrap: on
line source

---
summary: Module for improving the life of bot authors
---

This module makes it easier to write MUC bots by removing the
requirement that the bot be online and joined to the room.

All the bot needs to do is send a message and this module handles the
rest.

# Configuration

Example configuration in Prosody:

```lua
Component "muc.example.com" "muc"

modules_enabled = {
    "muc_bot",
}
known_bots = { "bot@example.com" }
bots_get_messages = false
ignore_bot_errors = true
```

# Sending messages

Simply send a stanza like this from your bot:

```xml
<message type="groupchat" to="channel@muc.example.com">
  <body>Beep boop, I'm a bot!</body>
  <nick xmlns="http://jabber.org/protocol/nick">Botty</nick>
</message>
```

## Use with mod_rest

Using [mod_rest] to interact with MUC suffers from the same need to join
with an online resource, so this module helps with that as well!

```bash
curl https://xmpp.example.com/rest/message/groupchat/room@muc.example.com \
    -d body="beep boop" \
    -d nick="Botty"
```

# Compatibility

Works with Prosody 0.12 or later.