Dodaj ukaze s poševnico

Hiter začetek

1. 1

   Ustvari trigger

   V namizni aplikaciji v svoji skupnosti odpri Manage Server → Triggers in dodaj trigger: ukaz, na katerega se odzove, na primer /weather, in URL tvoje spletne storitve.

2. 2

   Prejmi sporočilo

   Ko član pošlje sporočilo, ki se začne z /weather, ga mssgs z zahtevo POST pošlje na tvoj URL:

   jsonKopiraj

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

   Odgovori z JSON-om

   V 5 sekundah odgovori s statusom 2xx in JSON-om. V kanalu postane kartica.

   jsonKopiraj

   {
     "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, rahel dež do 16:00

   Wind

   SW 18 km/h

   Humidity

   82%

   18:45, maya triggered /weather command

Nastavitve

Vsak trigger ima v Manage Server → Triggers te nastavitve.

Kaj prejmeš

Zahtevo POST s telesom JSON. Med glavami je User-Agent: mssgs-webhook/1.0.

Preverjanje, kdo sme kaj

Primerjaj message.group_guids z vlogami, ki jim zaupaš, na primer da lahko /ban zaženejo samo moderatorji. Če želiš ukaz vsem drugim povsem skriti, mu nastavi vloge v nastavitvah triggerja.

Kaj odgovoriš

Kateri koli status 2xx s telesom JSON, do 4 MB. Pošlji vsaj eno od polj message_container ali actions.

Pet sekund

mssgs na tvoj odgovor čaka 5 sekund. Če potrebuješ več časa, takoj odgovori s kartico z indikatorjem nalaganja in končaj prek callback_url, ki velja 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 } })
});

Zasebni odgovori

V visible_to_member_guids vpiši ID-je članov in tvoj odgovor vidijo samo oni. Uporabi member_guid iz zahteve, da odgovoriš le osebi, ki je vprašala.

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

Celoten primer

Ukaz /weather v Node.js z Expressom, ki odgovori s kartico.

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

Omejitve