Incoming poll update message#

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

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

typeWebhook = IncomingMessageReceived

messageData.typeMessage = pollUpdateMessage

Webhook#

פרמטרים של Webhook#

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

פרמטר	הקלד	תיאור
`typeMessage`	מחרוזת	סוג הודעה נכנסת. עבור הודעות מסוג זה הפרמטר מקבל את הערך `pollUpdateMessage`.
`pollMessageData`	חפץ	אובייקט נתוני הודעת סקר

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

פרמטר	הקלד	תיאור
`stanzaId`	מחרוזת	מזהה הודעת סקר
`שם`	מחרוזת	שם הסקר
`הצבעות`	מערך	מערך אפשרויות סקר
`תשובות מרובות`	בוליאנית	אפשר מספר תשובות. `true` - מופעל, `false` - מושבת, ברירת מחדל: `false`

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

פרמטר	הקלד	תיאור
`OptionName`	מחרוזת	שם אפשרות
`אופציה מצביעים`	מערך	מערך משתמשי wid שבחרו באפשרות

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

פרמטר	הקלד	תֵאוּר
`ברירת מחדל`	מחרוזת	משתמש wid שבחר באפשרות

דוגמה לגוף 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": "pollUpdateMessage",
    "pollMessageData": {
      "stanzaId": "BAE53AFDD5F0C000",
      "name": "Poll Name",
      "votes": [
        {
          "optionName": "Variant 1",
          "optionVoters": []
        },
        {
          "optionName": "Variant 2",
          "optionVoters": ["79001234568@c.us"]
        }
      ],
      "multipleAnswers": false
    }
  }
}