Skip to content

SendPoll#

Test

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

בַּקָשָׁה#

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

POST
{{apiUrl}}/waInstance{{idInstance}}/sendPoll/{{apiTokenInstance}}
TEST

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

בקש פרמטרים#

פָּרָמֶטֶר סוּג דָרוּשׁ תֵאוּר
chatId string כֵּן מזהה צ'אט
message string כֵּן טקסט הודעה. דמויות אימוג'י 😃 נתמכות. האורך המרבי של טקסט ההודעה הוא 255 תווים.
options array כֵּן מערך אפשרויות סקר. מספר אפשרויות התשובה בסקר לא יכול להיות יותר מ-12. אפשרויות תשובה חייבות להיות שונות זו מזו בסמל אחד לפחות.
multipleAnswers boolean לֹא אפשר מספר תשובות. true - מופעל, false - מושבת, ברירת מחדל: false
quotedMessageId string לֹא אם צוין, ההודעה תישלח בציטוט הודעת הצ'אט שצוינה

options שדות מערך:

פָּרָמֶטֶר סוּג תֵאוּר
optionName string טקסט אפשרות בחירת סקר

בקשת גוף לדוגמה{#request-example-body}#

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

{
    "chatId": "11001234567@c.us",
    "message": "Please choose the color:",
    "options": [
        {"optionName": "green"},
        {"optionName": "red"},
        {"optionName": "blue"}
    ],
    "multipleAnswers": false,
}

תְגוּבָה#

שדות תגובה#

שָׂדֶה Type תאור
idMessage string מזהה ההודעה שנשלחה

גוף לדוגמא תגובה{#response-example-body}#

{
    "idMessage": "3EB0C767D097B7C7C030"
}

דוגמה לתצוגה עבור המקלט#

דוגמה לתצוגת סקר

SendMessage שגיאות#

לרשימה של שגיאות משותפות לכל השיטות, עיין ב שגיאות נפוצות section

טקסט תגובה לדוגמה#

import requests

url = "{{apiUrl}}/waInstance{{idInstance}}/sendPoll/{{apiTokenInstance}}"

payload = {
    "chatId": "11001234567@c.us",
    "message": "Please choose the color:",
    "options": [
        {"optionName": "green"},
        {"optionName": "red"},
        {"optionName": "blue"}
    ],
    "multipleAnswers": True
}

headers = {
'Content-Type': 'application/json'
}

response = requests.post(url, json=payload, headers=headers)

print(response.text.encode('utf8'))
curl --location --request POST '{{apiUrl}}/waInstance{{idInstance}}/sendPoll/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "chatId": "11001234567@c.us",
    "message": "Please choose the color:",
    "options": [{"optionName": "green"}, {"optionName": "red"}, {"optionName": "blue"}]
}'
Sub SendPoll()
    Dim url As String
    Dim RequestBody As String
    Dim http As Object
    Dim response As String

    ' The apiUrl, idInstance and apiTokenInstance values are available in console, double brackets must be removed
    url = "{{apiUrl}}/waInstance{{idInstance}}/sendPoll/{{apiTokenInstance}}"

    ' chatId - chat identifier, message - message text, options - array of data about choice options, multipleAnswers - allow multiple answers. true - enabled, false - disabled, Default: false
    RequestBody = "{""chatId"":""71234567890@c.us"",""message"":""Please choose the color:"",""options"":[{""optionName"":""green""},{""optionName"":""red""},{""optionName"":""blue""}],""multipleAnswers"":false}"

    Set http = CreateObject("MSXML2.XMLHTTP")

    With http
        .Open "POST", url, False
        .setRequestHeader "Content-Type", "application/json"
        .send RequestBody
    End With

    response = http.responseText

    Debug.Print response

    ' Outputting the answer to the desired cell
    Range("A1").Value = response

    Set http = Nothing
End Sub