Skip to content

Incoming messages#

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

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

incomingMessageReceived webhook פרמטרים#

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

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

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

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

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

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

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

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