Slash-commando's toevoegen

Snel aan de slag

1. 1

   Maak de trigger aan

   Open in de desktop-app bij je community Server beheren → Triggers en voeg er een toe: het commando waarop hij reageert, zoals /weather, en de URL van je webservice.

2. 2

   Ontvang het bericht

   Stuurt een lid een bericht dat begint met /weather, dan POST mssgs het naar je URL:

   jsonKopieer

   {
     "server_guid": "abc12345-...",
     "channel_guid": "def67890-...",
     "trigger_match": "/weather",
     "message": {
       "id": "d01ZZdef6-...",
       "content": "/weather Amsterdam",
       "member_guid": "member-guid",
       "user_guid": "user-guid",
       "group_guids": ["group-guid-1", "group-guid-2"],
       "cms": 1790000000000
     },
     "callback_url": "https://mss.gs/api/v1/trigger-callback/...",
     "stream_url": "https://mss.gs/api/v1/instant/...?token=..."
   }

3. 3

   Antwoord met JSON

   Antwoord binnen 5 seconden met een 2xx-status en JSON. Dat wordt een kaart in het kanaal.

   jsonKopieer

   {
     "message_container": {
       "color": "blue",
       "title": "Amsterdam",
       "description": "14 °C, light rain until 16:00",
       "fields": [
         { "field": "Wind", "value": "SW 18 km/h" },
         { "field": "Humidity", "value": "82%" }
       ]
     }
   }

   #general

   MA

   maya18:45

   /weather Amsterdam

   

   Bericht van Weekend Crew

   Amsterdam

   14 °C, lichte regen tot 16:00

   Wind

   SW 18 km/h

   Humidity

   82%

   18:45, maya triggered /weather command

Instellingen

Elke trigger heeft deze instellingen in Server beheren → Triggers.

Wat je ontvangt

Een POST met een JSON-body. In de headers staat onder meer User-Agent: mssgs-webhook/1.0.

Controleren wie wat mag

Vergelijk message.group_guids met de rollen die je vertrouwt, bijvoorbeeld om alleen moderators /ban te laten gebruiken. Wil je een commando helemaal afschermen voor alle anderen, stel dan de rollen in bij de instellingen van de trigger.

Wat je antwoordt

Elke 2xx-status met een JSON-body, tot 4 MB. Stuur minstens een van message_container of actions.

Vijf seconden

mssgs wacht 5 seconden op je antwoord. Heb je meer tijd nodig, antwoord dan meteen met een loaderkaart en maak het af via callback_url, die 30 minuten geldig blijft.

// Answer within 5 seconds with a loader...
res.json({ message_container: { loader: true, loader_text: 'Looking it up…' } });

// ...then finish in your own time with the callback URL.
await fetch(req.body.callback_url, {
  method: 'PUT',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({ message_container: { color: 'blue', title: 'Done', description: result } })
});

Privé antwoorden

Zet member-id's in visible_to_member_guids en alleen die leden zien je antwoord. Gebruik de member_guid uit het request om alleen degene te antwoorden die het vroeg.

{
  "message_container": {
    "color": "green",
    "title": "You're on the list",
    "description": "Only you can see this reply."
  },
  "visible_to_member_guids": ["<message.member_guid from the request>"]
}

Een volledig voorbeeld

Een /weather-commando in Node.js met Express, dat antwoordt met een kaart.

import express from 'express';

const app = express();
app.use(express.json());

app.post('/mssgs/weather', async (req, res) => {
  const city = req.body.message.content.replace('/weather', '').trim() || 'Amsterdam';
  const w = await getWeather(city); // your own lookup

  res.json({
    message_container: {
      color: 'blue',
      title: city,
      description: `${w.temp} °C, ${w.summary}`,
      fields: [
        { field: 'Wind', value: w.wind },
        { field: 'Humidity', value: `${w.humidity}%` }
      ]
    }
  });
});

app.listen(3000);

Limieten