Incoming buttons message#

סעיף זה מתאר פורמט אינטרנט נכנס של אובייקט 'messageData' עבור הודעת לחצנים נכנסת. לתיאור של הפורמט הכללי של webhooks נכנסות, עיין ב הודעות נכנסות סָעִיף.

כדי לקבל webhooks נכנס מסוג זה, שני תנאים חייבים להתקיים:

typeWebhook = incomingMessageReceived

messageData.typeMessage = buttonsMessage

Webhook#

פרמטרים של Webhook#

messageData פרמטרים של אובייקט

פָּרָמֶטֶר	סוּג	תֵאוּר
`typeMessage`	string	סוג הודעה נכנסת. עבור הודעות מסוג זה הפרמטר מקבל את הערך `buttonsMessage`
`buttonsMessage`	object	אובייקט נתונים של לחצנים
`quotedMessage`	object	אובייקט נתוני הודעה מצוטט. הצג רק אם ההודעה עצמה היא ציטוט

buttonsMessage פרמטרים של אובייקט

פָּרָמֶטֶר	סוּג	תֵאוּר
`contentText`	string	הודעת טקסט של כפתורים
`footer`	string	הודעת טקסט בכותרת תחתונה של כפתורים
`buttons`	object	אובייקט נתונים של לחצנים
`isForwarded`	boolean	בין אם ההודעה מועברת, מקבלת ערכים נכון/לא נכון
`forwardingScore`	integer	מספר העברות ההודעות

buttons פרמטרים של אובייקט

פָּרָמֶטֶר	סוּג	תֵאוּר
`buttonId`	string	מזהה לחצן
`buttonText`	string	טקסט לחצן

quotedMessage פרמטרים של אובייקט

פָּרָמֶטֶר	סוּג	תֵאוּר
`stanzaId`	string	מזהה הודעה מצוטט
`participant`	string	מצוטט מזהה שולח ההודעה
`typeMessage`	string	סוג הודעה מצוטט

שאר השדות ממולאים בהתאם לסוג ההודעה המצוטטת והם זהים לשדות ההודעות הנכנסות המתוארות ב הודעות נכנסות סָעִיף

דוגמה לגוף Webhook#

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
    "idInstance": 1234,
    "wid": "11001234567@c.us",
    "typeInstance": "whatsapp"
  },
  "timestamp": 1588091580,
  "idMessage": "F7AEC1B7086ECDC7E6E45923F5EDB825",
  "senderData": {
    "chatId": "79001234568@c.us",
    "sender": "79001234568@c.us",
    "chatName": "John",
    "senderName": "John",
    "senderContactName": "John Doe"
  },
    "messageData": {
        "typeMessage": "buttonsMessage",
        "buttonsMessage": {
            "contentText": "Hello",
            "footer": "Hello",
            "buttons": [
                {
                    "buttonId": "1",
                    "buttonText": "green"
                },
                {
                    "buttonId": "2",
                    "buttonText": "red"
                },
                {
                    "buttonId": "3",
                    "buttonText": "blue"
                }
            ],
             "forwardingScore": 4,
             "isForwarded": true
        }
    }
}