Skip to content

Incoming poll message#

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

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

typeWebhook = IncomingMessageReceived

messageData.typeMessage = pollMessage

Webhook#

פרמטרים של Webhook#

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

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

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

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

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

פרמטר הקלד תיאור
OptionName מחרוזת שם אפשרות

דוגמה לגוף 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": "pollMessage",
    "pollMessageData": {
      "name": "Poll Name",
      "options": [
        {
          "optionName": "Variant 1"
        },
        {
          "optionName": "Variant 2"
        }
      ],
      "multipleAnswers": false
    }
  }
}