Skip to content

Incoming contact message#

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

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

typeWebhook = incomingMessageReceived

messageData.typeMessage = contactMessage

Webhook#

Webhook parameters#

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

פָּרָמֶטֶר סוּג תֵאוּר
typeMessage string סוג הודעה נכנסת. עבור הודעות מסוג זה הפרמטר מקבל את הערך contactMessage
contactMessageData object אובייקט נתוני איש קשר נכנס.
quotedMessage object אובייקט נתוני הודעה מצוטט. הצג רק אם ההודעה עצמה היא ציטוט

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

פָּרָמֶטֶר סוּג תֵאוּר
displayName string הוצג שם איש קשר
vcard string מבנה VCard (כרטיס ביקור ליצירת קשר)
isForwarded boolean
forwardingScore integer

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

פָּרָמֶטֶר סוּג תֵאוּר
stanzaId string מזהה הודעה מצוטט
participant string מצוטט מזהה שולח ההודעה
typeMessage string סוג הודעה מצוטט

שאר השדות ממולאים בהתאם לסוג ההודעה המצוטטת והם זהים לשדות ההודעות הנכנסות המתוארות ב הודעות נכנסות סָעִיף

דוגמה לגוף 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": "contactMessage",
    "contactMessageData": {
      "displayName": "Victor Andreevich",
      "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Andreevich;Victor;;;\nFN:Victor Andreevich\nORG:Image\nTITLE:\nitem1.TEL;waid=79001234569:+7 900 123-45-69\nitem1.X-ABLabel:Mobile\nEND:VCARD",
      "forwardingScore": 4,
      "isForwarded": true
    }
  }
}

איש קשר והצעת הודעת טקסט הודעה נכנסת דוגמה לגוף ה-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": "contactMessage",
    "contactMessageData": {
      "displayName": "Anti-spam",
      "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:;Anti-spam;;;\nFN:Anti-spam\nitem1.TEL:*9035936232#\nitem1.X-ABLabel:Mobile\nEND:VCARD",
      "forwardingScore": 4,
      "isForwarded": true
    },
    "quotedMessage": {
      "stanzaId": "9A73322488DCB7D9689A6112F2528C9D",
      "participant": "79001235696@c.us",
      "typeMessage": "textMessage",
      "textMessage": "Hello"
    }
  }
}

איש קשר ואודיו/וידאו/ציטוט הודעה נכנסת דוגמה לגוף ה-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": "contactMessage",
    "contactMessageData": {
          "displayName": "Anti-spam",
          "vcard": "BEGIN:VCARD\nVERSION:3.0\nFN:2 Lena\nitem1.TEL;waid=79001230000\nitem1.X-ABLabel:Mobile\nEND:VCARD",
          "forwardingScore": 4,
          "isForwarded": true
    }
    },
    "quotedMessage": {
         "stanzaId": "9A73322488DCB7D9689A6112F2528C9D",
         "participant": "79061230000@c.us",
         "typeMessage": "imageMessage",
         "downloadUrl": "",
         "caption": "",
         "jpegThumbnail": ""
    }
  }

יצירת קשר והצעה ליצירת קשר דוגמה לגוף ההודעה הנכנסת 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": "contactMessage",
    "contactMessageData": {
      "displayName": "",
      "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Fond;\nitem1.TEL;waid=79001203030:/em1.X-ABLabel:New type\nEND:VCARD",
      "forwardingScore": 4,
      "isForwarded": true
    },
    "quotedMessage": {
      "stanzaId": "9A73322488DCB7D9689A6112F2528C9D",
      "participant": "79061230000@c.us",
      "typeMessage": "contactMessage",
      "contact": {
        "displayName": "Green-Api",
        "vcard": "BEGIN:VCARD\nVERSION:3.0\nN:Green-Api\nitem1.TEL;waid=79001230000\nitem1.X-ABLabel:Mobile\nEND:VCARD"
      }
    }
  }
}

איש קשר והצעה למיקום הודעה נכנסת webhook body דוגמה#

{
  "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": "contactMessage",
    "contactMessageData": {
      "displayName": "Fond",
      "vcard": "BEGIN:VCARD\nVERSION:3.0\nFN:2 Hearts\nitem1.TEL;waid=79200000102\nitem1.X-ABLabel:New type\nEND:VCARD",
      "forwardingScore": 4,
      "isForwarded": true
    },
    "quotedMessage": {
      "stanzaId": "9A73322488DCB7D9689A6112F2528C9D",
      "participant": "79060002233@c.us",
      "typeMessage": "locationMessage",
      "location": {
        "nameLocation": "",
        "address": "",
        "jpegThumbnail": "",
        "latitude": 72.5922702,
        "longitude": 45.6645388
      }
    }
  }
}