Dodaj komendy z ukośnikiem

Szybki start

1. 1

   Utwórz trigger

   W aplikacji desktopowej przejdź w swojej społeczności do Manage Server → Triggers i dodaj trigger: komendę, na którą reaguje, np. /weather, oraz URL twojej usługi sieciowej.

2. 2

   Odbierz wiadomość

   Gdy członek wyśle wiadomość zaczynającą się od /weather, mssgs wysyła ją żądaniem POST na twój URL:

   jsonKopiuj

   {
     "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

   Odpowiedz JSON-em

   Odpowiedz w ciągu 5 sekund ze statusem 2xx i JSON-em. Na kanale zamieni się on w kartę.

   jsonKopiuj

   {
     "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

   

   Message from Weekend Crew

   Amsterdam

   14 °C, lekki deszcz do 16:00

   Wind

   SW 18 km/h

   Humidity

   82%

   18:45, maya triggered /weather command

Ustawienia

Każdy trigger ma te ustawienia w Manage Server → Triggers.

Co otrzymujesz

Żądanie POST z treścią JSON. Wśród nagłówków jest User-Agent: mssgs-webhook/1.0.

Sprawdzanie, komu co wolno

Porównaj message.group_guids z rolami, którym ufasz, np. żeby tylko moderatorzy mogli uruchamiać /ban. Żeby komenda w ogóle nie działała dla nikogo innego, ustaw jej role w ustawieniach triggera.

Co odpowiadasz

Dowolny status 2xx z treścią JSON, do 4 MB. Wyślij co najmniej jedno z pól message_container lub actions.

Pięć sekund

mssgs czeka na twoją odpowiedź 5 sekund. Jeśli potrzebujesz więcej czasu, odpowiedz od razu kartą z loaderem i dokończ przez callback_url, który jest ważny przez 30 minut.

// 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 } })
});

Prywatne odpowiedzi

Wpisz identyfikatory członków w visible_to_member_guids, a tylko oni zobaczą twoją odpowiedź. Użyj member_guid z żądania, żeby odpowiedzieć tylko osobie, która pytała.

{
  "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>"]
}

Pełny przykład

Komenda /weather w Node.js z Expressem, odpowiadająca kartą.

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);

Limity