Incoming selection list message#

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

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

typeWebhook = IncomingMessageReceived

messageData.typeMessage = listMessage

Webhook#

פרמטרים של Webhook#

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

פרמטר	הקלד	תיאור
`typeMessage`	*string	סוג הודעה נכנסת. עבור הודעות מסוג זה הפרמטר מקבל את הערך `listMessage`
`רשימה הודעה`	object	אובייקט נתונים רשימת
`quotedMessage`	object	אובייקט נתוני הודעה מצוטט. הצג רק אם ההודעה עצמה היא ציטוט

אובייקט נתונים של 'listMessage'

פרמטר	הקלד	תיאור
`תוכןטקסט`	*string	הודעת טקסט של כפתורים
`כותרת`	*string	לא
`תחתונה`	*string	הודעת טקסט בכותרת התחתונה של כפתורים
`buttonText`	*string	לא
`קטעים`	array	כן
`מועבר`	בוליאנית	בין אם ההודעה מועברת, מקבלת ערכים נכון/לא נכון
`forwardingScore`	integer	מספר העברות ההודעות

פרמטרים של מערך 'קטעים'

פרמטר	הקלד	תיאור
`כותרת`	*string	כותרת רשימת הבחירה
`שורות`	array	ערכי רשימת בחירה

פרמטרים של מערך 'שורות'

פרמטר	הקלד	תיאור
`כותרת`	*string	טקסט ערך רשימה
`rowId`	*string	מזהה ערך רשימה
`תיאור`	*string	תיאור ערך רשימה

פרמטרי אובייקט quotedMessage

פרמטר	הקלד	תיאור
`stanzaId`	*string	מזהה הודעה מצוטט
`משתתף`	*string	מזהה שולח ההודעה המצוטט
`typeMessage`	*string	סוג הודעה מצוטט

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

דוגמה לגוף Webhook#

{
  "typeWebhook": "incomingMessageReceived",
  "instanceData": {
    "idInstance": 1234,
    "wid": "11001234567@c.us",
    "typeInstance": "whatsapp"
  },
  "timestamp": 1588091580,
  "idMessage": "F7AEC1B7086ECDC7E6E45923F5EDB825",
  "senderData": {
    "chatId": "79001234567@c.us",
    "sender": "79001234567@c.us",
    "chatName": "John",
    "senderName": "John",
    "senderContactName": "John Doe"
  },
    "messageData": {
        "typeMessage": "listMessage",
        "listMessage": {
            "contentText": "Hello",
            "title": "title",
            "footer": "Hello",
            "buttonText": "Action list",
            "sections": [
                {
                    "title": "Section 1",
                    "rows": [
                        {
                            "title": "Option 1",
                            "rowId": "option1"
                        },
                        {
                            "title": "Option 2",
                            "rowId": "option2",
                            "description": "Clarification"
                        }
                    ]
                },
                {
                    "title": "Section 2",
                    "rows": [
                        {
                            "title": "Option 3",
                            "rowId": "option3"
                        },
                        {
                            "title": "Option 4",
                            "rowId": "option4",
                            "description": "Clarification"
                }
            ],
             "forwardingScore": 4,
             "isForwarded": true
        }
    }
}