Skip to content

Incoming messages#

סעיף זה מתאר את הפורמט הכללי של webhooks נכנס עם סוג 'incomingMessageReceived'. תיאור של כל סוגי ה-webhooks הנכנסים ניתן בסעיף סוגי webhooks נכנסים.

המערכת מספקת קבלת הודעות על הודעות נכנסות מהסוגים הבאים:

incomingMessageReceived webhook פרמטרים#

פרמטר	הקלד	תֵאוּר
`typeWebhook`	*string	סוג webhook נכנס. עבור webhook מסוג זה, ה-paramaeter מקבל את הערך `incomingMessageReceived`
`instanceData`	object	נתוני מופע
`חותמת זמן`	integer	חותמת זמן לאירוע בפורמט UNIX
`idMessage`	*string	מזהה הודעה נכנסת
`senderData`	object	נתוני שולח ההודעה או הקובץ
`messageData`	object	נתוני הודעה או קובץ שהתקבלו

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

פרמטר	הקלד	תֵאוּר
`idInstance`	integer	מזהה מופע גודל המספר השלם הוא int64. טווח הערכים כולל בין 1 ל-10 ספרות
`wid`	*string	זיהוי חשבון בפורמט WhatsApp
`typeInstance`	*string	סוג שליח מופע

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

פרמטר	הקלד	תֵאוּר
`chatId`	*string	Chat ID, שבו התקבלה הודעה או קובץ
`שולח`	*string	שולח הודעה או קובץ Id
`שם צ'אט`	*string	שם צ'אט
`SenderName`	*string	שם השולח
`senderContactName`	*string	שם השולח לפי רשימת אנשי הקשר של החשבון הנוכחי

פרמטרי אובייקט `messageData`#

לאובייקט messageData יש פרמטרים שונים בהתאם לסוג ההודעה הנכנסת:

דוגמה לגוף 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":{
       // Depending on typeMessage = textMessage || imageMessage || videoMessage || documentMessage || audioMessage || locationMessage || contactMessage || extendedTextMessage || quotedMessage || pollMessage || pollUpdateMessage
       ...
       ...
       ...
        }
    }
}