Lisa nupud
Pane nupud mis tahes kaardi alla. Nupp avab lingi, muudab kaarti kõigi jaoks samal hetkel, kui keegi seda puudutab, või annab sinu teenusele teada, et seda vajutati.
Mida saad teha
- Ava linkSaada inimesed lehele, juhtpaneelile või pull requestile.
- Muuda kaarti ühe puudutusegaMuuda seda, eemalda see, reageeri või vasta otse vajutusest, ilma oma serverita.
- Kuule iga vajutustSinu teenus saab reaalajas teada, kes mida vajutas.
- Käivita käskNupp võib käivitada ühe kogukonna kaldkriipsukäskudest, koos andmetega.
Rakenduses
Keegi helistab uksekella: kaart ilmub
Puudutus nupul „Ava värav“: kaart muutub kõigi jaoks
Muudatuse enda jaoks pole serverit vaja: sammud on salvestatud koos sõnumiga. Sinu värava kontroller kuuleb vajutust ja avab värava.
Kiirstart
Lisa loend actions
Nupud käivad välja
actionsalla, kaardi kõrvale: webhooki postituses, käsu vastuses või uuenduses.json{ "message_container": { "color": "yellow", "title": "Deploy v2.1 to production?", "description": "Requested by maya." }, "actions": [ { "type": "url:https://ci.example.com/deploys/218", "text": "View changes", "color": "blue" } ] }deploysVali, mida vajutus teeb
Link, kaardi muutmine või päring sinu teenusele. Kolm tüüpi on kirjas allpool.
Kolm nupu tüüpi
Seda, mida vajutus teeb, määrab type.
| Tüüp | Mida vajutus teeb | Jõuab sinuni |
|---|---|---|
url:{url} | Avab lingi. | Ei |
webhook_action | Käivitab koos nupuga salvestatud sammud, kõigi jaoks kanalis. | Jah, sõnumi aadressil stream_url |
trigger:{guid} | Käivitab ühe kogukonna triggeritest ja annab kaasa nupu välja payload. | Jah, uue päringuna selle triggeri URL-ile |
Muuda kaarti ühe puudutusega
Nupp webhook_action kannab väljal triggers sammude loendit. Vajutuse peale käivituvad need järjest mssgs’i serveris ja tulemust näevad kõik kanalis.
| Samm | Mida see teeb, kõigi jaoks | Väljad |
|---|---|---|
update_message | Asendab kaardi ja selle nupud. Saada "actions": [], et nupud eemaldada. | message_container, actions, content |
remove_message | Kustutab sõnumi. | Puuduvad |
add_reaction | Lisab reaktsiooni vajutanud liikme nimel. | emoji |
add_reply | Postitab vastuse vajutanud liikme nimel. | content |
{
"message_container": { "color": "yellow", "title": "Front door", "description": "Someone rang the bell." },
"actions": [
{
"type": "webhook_action",
"id": "open_gate",
"text": "Open gate",
"color": "green",
"payload": { "door": "front" },
"triggers": [
{
"action": "update_message",
"message_container": { "color": "blue", "title": "Front door", "description": "Opening…" },
"actions": []
},
{ "action": "add_reaction", "emoji": ":white_check_mark:" }
]
}
]
}Kuula vajutust
Nuppudega sõnum tuleb webhookist tagasi koos väljaga stream_url. Hoia see lahti ja iga vajutus saabub sündmusena tüübiga action, koos nupu id-ga, salvestatud nupu ja selle väljaga payload ning infoga, kes vajutas:
data: {"type": "action", "message_id": "...", "action_id": "open_gate", "action": {"id": "open_gate", "payload": {"door": "front"}, ...}, "member_guid": "member-guid", "member": {...}, "ts": 1790000000000}Tee ära päris töö, näiteks ava värav, ja sea siis kaardi lõplik olek aadressi callback_url kaudu. Kuidas voog ja callback töötavad, loe lehelt reaalajas uuendused.
Käivita nupuga käsk
Nupp trigger:{guid} käivitab ühe sinu kogukonna triggeritest, justkui keegi oleks käsu sisestanud, ja annab üle nupu välja payload. Trigger saab:
{
"actions": [
{
"type": "trigger:5f2c9a1e-trigger-guid",
"text": "Check status",
"color": "blue",
"payload": { "order_id": "12345" }
}
]
}{
"trigger_match": "/status",
"message": {
"content": "[Action Triggered]",
"member_guid": "member-guid",
"is_action_button": true,
"action_payload": { "order_id": "12345" }
},
"callback_url": "https://mss.gs/api/v1/trigger-callback/...",
"stream_url": "https://mss.gs/api/v1/instant/...?token=..."
}payload.Väljad
| Väli | Tüüp | Mida see teeb |
|---|---|---|
type | string | url:{url}, webhook_action või trigger:{guid}. Kohustuslik. |
text | string | Nupu silt. Kohustuslik; töötab ka label. |
color | string | Nupu värv, vaata allpool. |
id | string | Tüübi webhook_action puhul: millist nuppu vajutati. Unikaalne sõnumi piires. |
payload | object | Sinu andmed, mis antakse vajutusel tagasi. |
triggers | array | Tüübi webhook_action puhul: käivitatavad sammud. |
disabled | boolean | Näitab nuppu hallina ja vajutused lükatakse tagasi. |
Värvid
green, blue ja purple joonistavad täidetud põhinupu. red, orange ja yellow joonistavad teisese nupu: kasuta neid nuppude „Lükka tagasi“, „Tühista“ ja muude ettevaatlike valikute jaoks.
Vead
Kui postitad nuppudega sõnumi, kontrollib mssgs need kõigepealt üle:
| Kood | Tähendus |
|---|---|
INVALID_ACTIONS_FORMAT | actions ei ole objektide loend. |
INVALID_ACTION_MISSING_FIELDS | Nupul puudub type või text. |
DUPLICATE_ACTION_ID | Kahel nupul on sama id. |
INVALID_TRIGGERS_FORMAT | triggers ei ole sammude loend. |
INVALID_TRIGGER_MISSING_ACTION | Sammul puudub action. |
INVALID_TRIGGER_ACTION_NOT_ALLOWED | Samm, mis pole üks neljast ülaltoodust. |
Kui keegi vajutab
| Kood | Tähendus |
|---|---|
MESSAGE_NOT_FOUND | Sõnum on vahepeal kustutatud. |
ACTION_NOT_FOUND | Sõnumil pole selle id-ga nuppu. |
ACTION_DISABLED | Nupp on välja lülitatud. |
TRIGGER_NOT_FOUND, TRIGGER_NOT_ACTIVE | Trigger, millele nupp viitab, on kadunud või välja lülitatud. |
TRIGGER_NOT_ALLOWED | Liikmel pole rolli, mis tohib seda triggerit kasutada. |
Tuled vanast dokumentatsioonist?
button nupud sammudega ws:send, local:update_message ja local:remove_message, tingimused previous:success ning expire_in_seconds ei tööta välistele saatjatele enam. Kasuta tüüpi webhook_action koos ülaltoodud sammudega: need jõuavad kõigini, mitte ainult vajutajani.