Incoming sticker message#

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

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

typeWebhook = IncomingMessageReceived

messageData.typeMessage = stickerMessage

Webhook#

פרמטרים של Webhook#

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

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

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

פרמטר	הקלד	תיאור
`כתובת אתר להורדה`	*string	כתובת אתר של מדבקה
`כיתוב`	*string	כיתוב קובץ
`שם קובץ`	*string	שם הקובץ
`jpeg Thumbnail`	*string	תצוגה מקדימה של תמונה ב-base64
`isAnimated`	בוליאנית	האם המדבקה מונפשת
`mimeType`	*string	סוג קובץ לפי הסיווג סוגי מדיה
`isForwarded`	בוליאנית	אם ההודעה מועברת, מקבלת ערכים אמת/לא נכון
`forwardingScore`	integer	מספר העברות הודעות

פרמטרי אובייקט 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",
    "chatName": "John",
    "sender": "79001234567@c.us",
    "senderName": "John",
    "senderContactName": "John Doe"
  },
  "messageData": {
    "typeMessage": "stickerMessage",
    "fileMessageData": {
      "downloadUrl": "https://sw-media.storage.greenapi.net/9901742665/607dde0a-01dc-4dd9-8afb-707cbf610943.webp",
      "caption": "",
      "fileName": "201ee6e7-b6f9-48fe-bc5a-1ce4341cce88.webp",
      "jpegThumbnail": "",
      "isAnimated": true,
      "mimeType": "image/webp",
      "forwardingScore": 1,
      "isForwarded": true
    },
    "quotedMessage": {
      "stanzaId": "A16014FAC9F5382E7B9CEEFEF1FFEB6F",
      "participant": "79001234567@c.us"
    }
  }
}