Skip to content

שלח הודעת רשימה#

שים לב, בבקשה! השיטה לא עובדת באופן זמני

כאשר השיטה נקראת, תוחזר שגיאת 403.

השיטה מכוונת לשליחת הודעה עם כפתור בחירה מרשימת ערכים לצ'אט אישי או קבוצתי. ההודעה תתווסף לתור השליחה. ההודעה תישמר 24 שעות בתור ותשלח מיד לאחר אישור טלפוני. קצב שליחת ההודעות מהתור מנוהל על ידי פרמטר עיכוב שליחת הודעות.

בקשה#

כדי לשלוח הודעה, עליך לבצע בקשה בכתובת:

פוסט 
{{apiUrl}}/waInstance{{idInstance}}/sendListMessage/{{apiTokenInstance}}

לפרמטרים של בקשת apiUrl, idInstance ו-apiTokenInstance, עיין בסעיף לפני שמתחילים.

תכונות בעבודה עם כפתורים#

  • יכולים להיות בין 3 ל-10 כולל;
  • אורך כותרת הכפתור הוא עד 24 תווים;
  • ייתכן שכותרות פריטי התפריט יחזרו על עצמם.

פרמטרי בקשה#

פרמטר הקלד חובה תֵאוּר
chatId מחרוזת כן צ'אט מזהה
הודעה מחרוזת כן טקסט הודעה. דמויות Emoji 😃 נתמכות
כותרת מחרוזת לא כותרת ההודעה.
תחתונה מחרוזת לא כותרת תחתונה של הודעה. שימושי להדגשה ויזואלית של טקסט הקשור ללחצנים.
כפתורטקסט מחרוזת כן בחר טקסט לחצן רשימה
קטעים מערך כן בחר ערכי רשימה
quotedMessageId מחרוזת לא מזהה הודעה מצוטט. אם קיימת, ההודעה תישלח בציטוט הודעת הצ'אט שצוינה

פרמטרים של מערך 'קטעים'

פרמטר הקלד תיאור
כותרת מחרוזת בחר כותרת רשימה
שורות מערך בחר ערכי רשימה

פרמטרים של מערך 'שורות'

פרמטר הקלד תיאור
כותרת מחרוזת טקסט ערך רשימה
rowId מחרוזת ערך רשימה מזהה

האורך המרבי של הודעת טקסט הוא 4096 תווים

דוגמה לגוף הבקשה#

שליחת הודעה לצ'אט אישי: 

{
    "chatId": "11001234567@c.us",
    "message": "Message text",
    "title": "title",
    "footer": "footer",
    "buttonText": "Action list",
    "sections": [
        {
            "title": "Section 1",
            "rows": [
                {
                    "title": "Option 1",
                    "rowId": "option1"
                },
                {
                    "title": "Option 2",
                    "rowId": "option2",
                    "description": "Description"
                }
            ]
        },
        {
            "title": "Section 2",
            "rows": [
                {
                    "title": "Option 3",
                    "rowId": "option3"
                },
                {
                    "title": "Option 4",
                    "rowId": "option4",
                    "description": "Description"
                }
            ]
        }
    ]
}

Response#

Response parameters#

Parameter Type Description
idMessage string Sent message Id

Response body example#

{
    "idMessage": "3EB0C767D097B7C7C030"
}

Recipient display example#

Пример списка выбора

SendMessage errors#

For a list of errors common to all methods, refer to Common errors section

Possible mistakes

When using the SendListMessage method, messages may not be displayed on the web, desktop, and mobile versions of the application. The ability to send messages with buttons is implemented by us in a low-level way. The official WhatsApp-Web client does not provide the functionality of sending buttons. To a large extent, the stability of the SendListMessage method does not depend on us, WhatsApp constantly makes changes to their work.

We recommend that you always duplicate buttons with regular messages.

For example, use numbers to define choices.

Choose an action:

1 - action 1

2 - action 2

3 - action 3

curl example#

curl --location --request POST '{{apiUrl}}/waInstance{{idInstance}}/sendListMessage/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "chatId": "11001234567@c.us",
    "message": "Message text",
    "buttonText": "Action list",
    "title": "title",
    "footer": "footer",
    "sections": [
        {
            "title": "Section 1",
            "rows": [
                {
                    "title": "Option 1",
                    "rowId": "option1"
                },
                {
                    "title": "Option 2",
                    "rowId": "option2",
                    "description": "Description"
                }
            ]
        },
        {
            "title": "Secton 2",
            "rows": [
                {
                    "title": "Option 3",
                    "rowId": "option3"
                },
                {
                    "title": "Option 4",
                    "rowId": "option4",
                    "description": "Description"
                }
            ]
        }
    ]
}'