Додайте слеш-команди

Швидкий старт

1. 1

   Створіть тригер

   У настільному застосунку відкрийте у своїй спільноті Manage Server → Triggers (керування сервером, тригери) і додайте тригер: команду, на яку він реагує, наприклад /weather, і URL вашого вебсервісу.

2. 2

   Отримайте повідомлення

   Коли учасник надсилає повідомлення, що починається з /weather, mssgs надсилає його методом POST на ваш URL:

   jsonКопіювати

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

   Відповідайте JSON

   Відповідайте протягом 5 секунд зі статусом 2xx і JSON. Відповідь стане карткою в каналі.

   jsonКопіювати

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

   

   Повідомлення від Weekend Crew

   Amsterdam

   14 °C, невеликий дощ до 16:00

   Wind

   SW 18 km/h

   Humidity

   82%

   18:45, maya triggered /weather command

Налаштування

Кожен тригер має такі налаштування в Manage Server → Triggers.

Що ви отримуєте

POST-запит із JSON-тілом. Серед заголовків є User-Agent: mssgs-webhook/1.0.

Перевірка, кому що дозволено

Порівнюйте message.group_guids із ролями, яким довіряєте, наприклад щоб лише модератори могли виконувати /ban. Щоб повністю приховати команду від усіх інших, задайте її ролі в налаштуваннях тригера.

Що ви відповідаєте

Будь-який статус 2xx із JSON-тілом розміром до 4 МБ. Надішліть щонайменше одне з полів: message_container або actions.

П’ять секунд

mssgs чекає на вашу відповідь 5 секунд. Якщо вам потрібно більше часу, одразу відповідайте карткою з індикатором завантаження й завершуйте через callback_url, який залишається дійсним 30 хвилин.

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

Приватні відповіді

Вкажіть id учасників у visible_to_member_guids, і вашу відповідь бачитимуть лише вони. Використовуйте member_guid із запиту, щоб відповісти лише тому, хто запитав.

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

Повний приклад

Команда /weather на Node.js з Express, що відповідає карткою.

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

Ліміти