Добавьте слэш-команды

Быстрый старт

1. 1

   Создайте триггер

   В настольном приложении откройте в своём сообществе Управление сервером → Триггеры и добавьте триггер: команду, на которую он реагирует, например /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

Настройки

У каждого триггера есть эти настройки в разделе Управление сервером → Триггеры.

Что вы получаете

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

Лимиты