Skip to content

Incoming template buttons message#

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

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

typeWebhook = IncomingMessageReceived

messageData.typeMessage = templateMessage

Webhook#

פרמטרים של Webhook#

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

פרמטר הקלד תיאור
typeMessage מחרוזת סוג הודעה נכנסת. עבור הודעות מסוג זה הפרמטר מקבל את הערך templateMessage
templateMessage חפץ אובייקט נתונים של לחצנים
quotedMessage חפץ אובייקט נתוני הודעה מצוטט. הצג רק אם ההודעה עצמה היא ציטוט

פרמטרי אובייקט 'templateMessage'

פרמטר הקלד תיאור
מרחב שמות מחרוזת שמות הארגון החלל
elementName מחרוזת שם הודעת תבנית
תוכןטקסט מחרוזת הודעת טקסט של כפתורים
תחתונה מחרוזת הודעת טקסט בכותרת התחתונה של כפתורים
כפתורים חפץ אובייקט נתונים של לחצנים
מועבר בוליאנית בין אם ההודעה מועברת, מקבלת ערכים נכון/לא נכון
forwardingScore מספר שלם מספר העברות ההודעות

פרמטרי אובייקט 'לחצנים'

פרמטר הקלד תיאור
אינדקס מחרוזת מדד הכפתורים
urlButton חפץ אובייקט נתונים של לחצן כתובת URL
כפתור שיחה חפץ אובייקט נתונים של לחצן התקשרות חזרה
quickReplyButton חפץ אובייקט נתונים של לחצן תשובה מהירה

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

פרמטר הקלד תיאור
displayText מחרוזת טקסט כתובת אתר של לחצן
כתובת אתר מחרוזת קישור

פרמטרי אובייקט 'callButton'

פרמטר הקלד תיאור
displayText מחרוזת טקסט לחצן התקשרות חזרה
מספר טלפון מחרוזת מספר טלפון

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

פרמטר הקלד תיאור
displayText מחרוזת טקסט לחצן תשובה מהירה
מזהה מחרוזת מזהה לחצן תשובה מהירה

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

פרמטר הקלד תיאור
stanzaId מחרוזת מזהה הודעה מצוטט
משתתף מחרוזת מזהה שולח ההודעה המצוטט
typeMessage מחרוזת סוג הודעה מצוטט

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

דוגמה לגוף 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": "templateMessage",
        "templateMessage": {
            "contentText": "Hello",
            "footer": "Hello",
            "buttons": [
                {
                    "urlButton": {
                        "displayText": "⭐ Star us on GitHub!",
                        "url": "https://github.com/green-api"
                    },
                    "index": 1
                },
                {
                    "callButton": {
                        "displayText": "Call us",
                        "phoneNumber": "+1 (234) 5678-901"
                    },
                    "index": 2
                },
                {
                    "quickReplyButton": {
                        "displayText": "Hello",
                        "id": "plainButtonId"
                    },
                    "index": 3
                }
            ],
            "forwardingScore": 4,
            "isForwarded": true
        }
    }
}