ΠŸΠ΅Ρ€Π΅ΠΉΡ‚ΠΈ ΠΊ ΡΠΎΠ΄Π΅Ρ€ΠΆΠ°Π½ΠΈΡŽ

SendPoll#

Test Postman Apidog

ΠœΠ΅Ρ‚ΠΎΠ΄ ΠΏΡ€Π΅Π΄Π½Π°Π·Π½Π°Ρ‡Π΅Π½ для ΠΎΡ‚ΠΏΡ€Π°Π²ΠΊΠΈ сообщСния с опросом Π² Π»ΠΈΡ‡Π½Ρ‹ΠΉ ΠΈΠ»ΠΈ Π³Ρ€ΡƒΠΏΠΏΠΎΠ²ΠΎΠΉ Ρ‡Π°Ρ‚. Π‘ΠΎΠΎΠ±Ρ‰Π΅Π½ΠΈΠ΅ Π±ΡƒΠ΄Π΅Ρ‚ Π΄ΠΎΠ±Π°Π²Π»Π΅Π½ΠΎ Π² ΠΎΡ‡Π΅Ρ€Π΅Π΄ΡŒ Π½Π° ΠΎΡ‚ΠΏΡ€Π°Π²ΠΊΡƒ. Π‘ΠΎΠΎΠ±Ρ‰Π΅Π½ΠΈΠ΅ Π½Π° ΠΎΡ‚ΠΏΡ€Π°Π²ΠΊΡƒ хранится 24 часа Π² ΠΎΡ‡Π΅Ρ€Π΅Π΄ΠΈ ΠΈ Π±ΡƒΠ΄Π΅Ρ‚ ΠΎΡ‚ΠΏΡ€Π°Π²Π»Π΅Π½ΠΎ сразу ΠΆΠ΅ послС Π°Π²Ρ‚ΠΎΡ€ΠΈΠ·Π°Ρ†ΠΈΠΈ Ρ‚Π΅Π»Π΅Ρ„ΠΎΠ½Π°. Π‘ΠΊΠΎΡ€ΠΎΡΡ‚ΡŒ ΠΎΡ‚ΠΏΡ€Π°Π²ΠΊΠΈ сообщСний ΠΈΠ· ΠΎΡ‡Π΅Ρ€Π΅Π΄ΠΈ Ρ€Π΅Π³ΡƒΠ»ΠΈΡ€ΡƒΠ΅Ρ‚ ΠΏΠ°Ρ€Π°ΠΌΠ΅Ρ‚Ρ€ ΠΈΠ½Ρ‚Π΅Ρ€Π²Π°Π» ΠΎΡ‚ΠΏΡ€Π°Π²ΠΊΠΈ сообщСний.

Для получСния ΡƒΠ²Π΅Π΄ΠΎΠΌΠ»Π΅Π½ΠΈΠΉ с входящими ΠΎΡ‚Π²Π΅Ρ‚Π°ΠΌΠΈ Π½Π° ΠΎΡ‚ΠΏΡ€Π°Π²Π»Π΅Π½Π½Ρ‹Π΅ опросы Π½Π΅ΠΎΠ±Ρ…ΠΎΠ΄ΠΈΠΌΠΎ Π²ΠΊΠ»ΡŽΡ‡ΠΈΡ‚ΡŒ настройки инстанса ΠΎΠ΄Π½ΠΈΠΌ ΠΈΠ· прСдставлСнных Π²Π°Ρ€ΠΈΠ°Π½Ρ‚ΠΎΠ²:

  1. Π§Π΅Ρ€Π΅Π· Π»ΠΈΡ‡Π½Ρ‹ΠΉ ΠΊΠ°Π±ΠΈΠ½Π΅Ρ‚ Π²ΠΊΠ»ΡŽΡ‡ΠΈΡ‚ΡŒ настройки ΠŸΠΎΠ»ΡƒΡ‡Π°Ρ‚ΡŒ увСдомлСния ΠΎ входящих сообщСниях ΠΈ Ρ„Π°ΠΉΠ»Π°Ρ… ΠΈ ΠŸΠΎΠ»ΡƒΡ‡Π°Ρ‚ΡŒ увСдомлСния ΠΎΠ± опросах
  2. Π§Π΅Ρ€Π΅Π· ΠΌΠ΅Ρ‚ΠΎΠ΄ SetSettings Π²ΠΊΠ»ΡŽΡ‡ΠΈΡ‚ΡŒ настройки incomingWebhook ΠΈ pollMessageWebhook

Запрос#

Для ΠΎΡ‚ΠΏΡ€Π°Π²ΠΊΠΈ трСбуСтся Π²Ρ‹ΠΏΠΎΠ»Π½ΠΈΡ‚ΡŒ запрос ΠΏΠΎ адрСсу:

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

Для получСния ΠΏΠ°Ρ€Π°ΠΌΠ΅Ρ‚Ρ€ΠΎΠ² запроса apiUrl, idInstance ΠΈ apiTokenInstance ΠΎΠ±Ρ€Π°Ρ‚ΠΈΡ‚Π΅ΡΡŒ ΠΊ Ρ€Π°Π·Π΄Π΅Π»Ρƒ ΠŸΠ΅Ρ€Π΅Π΄ Π½Π°Ρ‡Π°Π»ΠΎΠΌ Ρ€Π°Π±ΠΎΡ‚Ρ‹.

ΠŸΠ°Ρ€Π°ΠΌΠ΅Ρ‚Ρ€Ρ‹ запроса#

ΠŸΠ°Ρ€Π°ΠΌΠ΅Ρ‚Ρ€ Π’ΠΈΠΏ ΠžΠ±ΡΠ·Π°Ρ‚Π΅Π»ΡŒΠ½Ρ‹ΠΉ ОписаниС
chatId string Π”Π° Π˜Π΄Π΅Π½Ρ‚ΠΈΡ„ΠΈΠΊΠ°Ρ‚ΠΎΡ€ Ρ‡Π°Ρ‚Π°
message string Π”Π° ВСкст сообщСния. ΠŸΠΎΠ΄Π΄Π΅Ρ€ΠΆΠΈΠ²Π°ΡŽΡ‚ΡΡ символы emoji πŸ˜ƒ. Максимальная Π΄Π»ΠΈΠ½Π° тСкстового сообщСния составляСт 255 символов.
options array Π”Π° Массив Π΄Π°Π½Π½Ρ‹Ρ… ΠΎ Π²Π°Ρ€ΠΈΠ°Π½Ρ‚Π°Ρ… Π²Ρ‹Π±ΠΎΡ€Π°. ΠšΠΎΠ»ΠΈΡ‡Π΅ΡΡ‚Π²ΠΎ Π²Π°Ρ€ΠΈΠ°Π½Ρ‚ΠΎΠ² ΠΎΡ‚Π²Π΅Ρ‚ΠΎΠ² Π² голосовании Π½Π΅ ΠΌΠΎΠΆΠ΅Ρ‚ Π±Ρ‹Ρ‚ΡŒ большС 12. Π’Π°Ρ€ΠΈΠ°Π½Ρ‚Ρ‹ ΠΎΡ‚Π²Π΅Ρ‚Π° Π΄ΠΎΠ»ΠΆΠ½Ρ‹ ΠΎΡ‚Π»ΠΈΡ‡Π°Ρ‚ΡŒΡΡ Π΄Ρ€ΡƒΠ³ ΠΎΡ‚ Π΄Ρ€ΡƒΠ³Π° ΠΌΠΈΠ½ΠΈΠΌΡƒΠΌ ΠΎΠ΄Π½ΠΈΠΌ символом.
multipleAnswers boolean НСт Π Π°Π·Ρ€Π΅ΡˆΠΈΡ‚ΡŒ нСсколько ΠΎΡ‚Π²Π΅Ρ‚ΠΎΠ². true β€” Π²ΠΊΠ»ΡŽΡ‡Π΅Π½ΠΎ, false β€” ΠΎΡ‚ΠΊΠ»ΡŽΡ‡Π΅Π½ΠΎ, По ΡƒΠΌΠΎΠ»Ρ‡Π°Π½ΠΈΡŽ: false
quotedMessageId string НСт Π˜Π΄Π΅Π½Ρ‚ΠΈΡ„ΠΈΠΊΠ°Ρ‚ΠΎΡ€ Ρ†ΠΈΡ‚ΠΈΡ€ΡƒΠ΅ΠΌΠΎΠ³ΠΎ сообщСния. ΠŸΡ€ΠΈ Π·Π°ΠΏΠΎΠ»Π½Π΅Π½ΠΈΠΈ ΠΏΠ°Ρ€Π°ΠΌΠ΅Ρ‚Ρ€Π° сообщСниС отправится с Ρ†ΠΈΡ‚ΠΈΡ€ΠΎΠ²Π°Π½ΠΈΠ΅ΠΌ ΡƒΠΊΠ°Π·Π°Π½Π½ΠΎΠ³ΠΎ сообщСния Ρ‡Π°Ρ‚Π°.
Π¦ΠΈΡ‚ΠΈΡ€ΠΎΠ²Π°Π½ΠΈΠ΅ сообщСния Π²ΠΎΠ·ΠΌΠΎΠΆΠ½ΠΎ Ρ‚ΠΎΠ»ΡŒΠΊΠΎ ΠΈΠ· Ρ‚ΠΎΠ³ΠΎ ΠΆΠ΅ Ρ‡Π°Ρ‚Π°, Π² ΠΊΠΎΡ‚ΠΎΡ€Ρ‹ΠΉ производится ΠΎΡ‚ΠΏΡ€Π°Π²ΠΊΠ°.
Для ΠΎΡ‚ΠΏΡ€Π°Π²ΠΊΠΈ сообщСний ΠΈΠ· Π΄Ρ€ΡƒΠ³ΠΎΠ³ΠΎ Ρ‡Π°Ρ‚Π° ΠΈΡΠΏΠΎΠ»ΡŒΠ·ΡƒΠ΅Ρ‚ΡΡ ΠΌΠ΅Ρ‚ΠΎΠ΄ ForwardMessages
typingTime integer НСт ВрСмя ΠΏΠΎΠΊΠ°Π·Π° увСдомлСния Π½Π°Π±ΠΎΡ€Π° сообщСния Π² Ρ‡Π°Ρ‚Π΅ собСсСдника.
ВрСмя ΠΎΠ³Ρ€Π°Π½ΠΈΡ‡Π΅Π½ΠΎ значСниями ΠΎΡ‚ 1000 Π΄ΠΎ 20000 миллисСкунд (ΠΎΡ‚ 1 Π΄ΠΎ 20 сСкунд).

Поля массива options

ΠŸΠ°Ρ€Π°ΠΌΠ΅Ρ‚Ρ€ Π’ΠΈΠΏ ОписаниС
optionName string ВСкст Π²Π°Ρ€ΠΈΠ°Π½Ρ‚Π° Π²Ρ‹Π±ΠΎΡ€Π°. Максимальная Π΄Π»ΠΈΠ½Π°
тСкста составляСт 100 символов.

Π¦ΠΈΡ‚ΠΈΡ€ΠΎΠ²Π°Π½ΠΈΠ΅ сообщСний

Для ΠΊΠΎΡ€Ρ€Π΅ΠΊΡ‚Π½ΠΎΠΉ Ρ€Π°Π±ΠΎΡ‚Ρ‹ с ΠΌΠ΅Ρ…Π°Π½ΠΈΠ·ΠΌΠΎΠΌ цитирования сообщСний систСма Π΄ΠΎΠ»ΠΆΠ½Π° Π·Π½Π°Ρ‚ΡŒ ΠΎ сообщСнии, ΠΊΠΎΡ‚ΠΎΡ€ΠΎΠ΅ Π±ΡƒΠ΄Π΅Ρ‚ ΠΏΡ€ΠΎΡ†ΠΈΡ‚ΠΈΡ€ΠΎΠ²Π°Π½ΠΎ. УбСдится ΠΎ Ρ‚ΠΎΠΌ Ρ‡Ρ‚ΠΎ сообщСниС доступно ΠΊ Ρ†ΠΈΡ‚ΠΈΡ€ΠΎΠ²Π°Π½ΠΈΡŽ ΠΌΠΎΠΆΠ½ΠΎ запросив ΠΌΠ΅Ρ‚ΠΎΠ΄ Турналирования getMessage, Ссли сообщСниС отсутствуСт Π² систСмС, Ρ‚ΠΎ Ρ†ΠΈΡ‚ΠΈΡ€ΠΎΠ²Π°Ρ‚ΡŒ Ρ‚Π°ΠΊΠΎΠ΅ сообщСниС Π½Π΅Π²ΠΎΠ·ΠΌΠΎΠΆΠ½ΠΎ.

  • Для цитирования входящих сообщСний Π½Π΅ΠΎΠ±Ρ…ΠΎΠ΄ΠΈΠΌΠΎ Π²ΠΊΠ»ΡŽΡ‡ΠΈΡ‚ΡŒ настройку ΠŸΠΎΠ»ΡƒΡ‡Π°Ρ‚ΡŒ увСдомлСния ΠΎ входящих сообщСниях ΠΈ Ρ„Π°ΠΉΠ»Π°Ρ….

  • Для цитирования исходящих сообщСний ΠΎΡ‚ΠΏΡ€Π°Π²Π»Π΅Π½Π½Ρ‹Ρ… с Ρ‚Π΅Π»Π΅Ρ„ΠΎΠ½Π°, Π²ΠΊΠ»ΡŽΡ‡ΠΈΡ‚Π΅ настройку ΠŸΠΎΠ»ΡƒΡ‡Π°Ρ‚ΡŒ увСдомлСния ΠΎ сообщСниях, ΠΎΡ‚ΠΏΡ€Π°Π²Π»Π΅Π½Π½Ρ‹Ρ… с Ρ‚Π΅Π»Π΅Ρ„ΠΎΠ½Π°.
    Π’Π°ΠΊ сообщСния Π±ΡƒΠ΄ΡƒΡ‚ ΠΏΠΎΠΏΠ°Π΄Π°Ρ‚ΡŒ Π² систСму ΠΈ ΠΈΡ… ΠΌΠΎΠΆΠ½ΠΎ Π±ΡƒΠ΄Π΅Ρ‚ Ρ†ΠΈΡ‚ΠΈΡ€ΠΎΠ²Π°Ρ‚ΡŒ.

Установку настроСк ΠΌΠΎΠΆΠ½ΠΎ ΡΠ΄Π΅Π»Π°Ρ‚ΡŒ ΠΌΠ΅Ρ‚ΠΎΠ΄ΠΎΠΌ SetSettings ΠΈΠ»ΠΈ Ρ‡Π΅Ρ€Π΅Π· Π»ΠΈΡ‡Π½Ρ‹ΠΉ ΠΊΠ°Π±ΠΈΠ½Π΅Ρ‚.

ΠŸΡ€ΠΈΠΌΠ΅Ρ€ Ρ‚Π΅Π»Π° запроса#

ΠšΠΎΠ»ΠΈΡ‡Π΅ΡΡ‚Π²ΠΎ Π²Π°Ρ€ΠΈΠ°Π½Ρ‚ΠΎΠ² ΠΎΡ‚Π²Π΅Ρ‚ΠΎΠ² Π² опросС

Для ΡƒΡΠΏΠ΅ΡˆΠ½ΠΎΠΉ ΠΎΡ‚ΠΏΡ€Π°Π²ΠΊΠΈ опроса количСство Π²Π°Ρ€ΠΈΠ°Π½Ρ‚ΠΎΠ² ΠΎΡ‚Π²Π΅Ρ‚Π° Π΄ΠΎΠ»ΠΆΠ½ΠΎ Π±Ρ‹Ρ‚ΡŒ Π½Π΅ ΠΌΠ΅Π½Π΅Π΅ 2 ΠΈ Π½Π΅ Π±ΠΎΠ»Π΅Π΅ 12.

ΠžΡ‚ΠΏΡ€Π°Π²ΠΊΠ° сообщСния Π² Π»ΠΈΡ‡Π½Ρ‹ΠΉ Ρ‡Π°Ρ‚:

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

ΠžΡ‚Π²Π΅Ρ‚#

Поля ΠΎΡ‚Π²Π΅Ρ‚Π°#

ПолС Вип ОписаниС
idMessage string Π˜Π΄Π΅Π½Ρ‚ΠΈΡ„ΠΈΠΊΠ°Ρ‚ΠΎΡ€ ΠΎΡ‚ΠΏΡ€Π°Π²Π»Π΅Π½Π½ΠΎΠ³ΠΎ сообщСния

ΠŸΡ€ΠΈΠΌΠ΅Ρ€ Ρ‚Π΅Π»Π° ΠΎΡ‚Π²Π΅Ρ‚Π°#

{
    "idMessage": "3EB0C767D097B7C7C030"
}

ΠŸΡ€ΠΈΠΌΠ΅Ρ€ отобраТСния Ρƒ получатСля#

ΠŸΡ€ΠΈΠΌΠ΅Ρ€ отобраТСния опроса

Ошибки SendPoll#

ΠŸΠ΅Ρ€Π΅Ρ‡Π΅Π½ΡŒ ΠΎΠ±Ρ‰ΠΈΡ… для всСх ΠΌΠ΅Ρ‚ΠΎΠ΄ΠΎΠ² ошибок смотритС Π² Ρ€Π°Π·Π΄Π΅Π»Π΅ Π‘Ρ‚Π°Π½Π΄Π°Ρ€Ρ‚Π½Ρ‹Π΅ ошибки

Код HTTP Π˜Π΄Π΅Π½Ρ‚ΠΈΡ„ΠΈΠΊΠ°Ρ‚ΠΎΡ€ ошибки ОписаниС
400 Bad Request
Validation failed
Ошибка Π²Π°Π»ΠΈΠ΄Π°Ρ†ΠΈΠΈ
400 Validation failed.
Details: 'message' length must be less than or equal to 255 characters long
Π”Π»ΠΈΠ½Π° сообщСния Π΄ΠΎΠ»ΠΆΠ½Π° Π±Ρ‹Ρ‚ΡŒ мСньшС ΠΈΠ»ΠΈ Ρ€Π°Π²Π½Π° 255 символам
400 Validation failed.
Details: 'optionName' length must be less than or equal to 100 characters long
Π”Π»ΠΈΠ½Π° Π²Π°Ρ€ΠΈΠ°Π½Ρ‚Π° ΠΎΡ‚Π²Π΅Ρ‚Π° Π΄ΠΎΠ»ΠΆΠ½Π° Π±Ρ‹Ρ‚ΡŒ мСньшС ΠΈΠ»ΠΈ Ρ€Π°Π²Π½Π° 100 символам
400 Validation failed.
Details: 'options[X].optionName' is required
НСкоррСктный ΠΊΠ»ΡŽΡ‡ для Π²Π°Ρ€ΠΈΠ°Π½Ρ‚Π° ΠΎΡ‚Π²Π΅Ρ‚Π° Π₯
400 Validation failed.
Details: 'options' length must be from 2 to 12 elements inclusive
НСкоррСктноС количСство Π²Π°Ρ€ΠΈΠ°Π½Ρ‚ΠΎΠ² ΠΎΡ‚Π²Π΅Ρ‚Π°
400 Validation failed.
Details: 'optionName' field must have unique value
Π’Π°Ρ€ΠΈΠ°Π½Ρ‚Ρ‹ ΠΎΡ‚Π²Π΅Ρ‚Π° Π½Π΅ Π΄ΠΎΠ»ΠΆΠ½Ρ‹ ΠΏΠΎΠ²Ρ‚ΠΎΡ€ΡΡ‚ΡŒΡΡ
500 request entity too large ΠŸΡ€Π΅Π²Ρ‹ΡˆΠ΅Π½ΠΈΠ΅ допустимой Π΄Π»ΠΈΠ½Ρ‹ json (>100ΠΊΠ±)

ΠžΡ‚ΠΏΡ€Π°Π²ΠΊΠ° с Π½Π΅Π²Π΅Ρ€Π½Ρ‹ΠΌ ΠΈΠ΄Π΅Π½Ρ‚ΠΈΡ„ΠΈΠΊΠ°Ρ‚ΠΎΡ€ΠΎΠΌ Ρ†ΠΈΡ‚ΠΈΡ€ΡƒΠ΅ΠΌΠΎΠ³ΠΎ сообщСния

Π’ случаС Π½Π΅ΠΊΠΎΡ€Ρ€Π΅ΠΊΡ‚Π½ΠΎΠ³ΠΎ указания quotedMessageId, систСма Π²Π΅Ρ€Π½Ρ‘Ρ‚ ΠΊΠΎΠ΄ 200 ΠΈ id отправляСмого сообщСния, Π½ΠΎ ΠΎΠ½ΠΎ Π½Π΅ Π±ΡƒΠ΄Π΅Ρ‚ доставлСно ΠΏΠΎΠ»ΡƒΡ‡Π°Ρ‚Π΅Π»ΡŽ.

ΠŸΡ€ΠΈΠΌΠ΅Ρ€Ρ‹ ΠΊΠΎΠ΄Π°#

import requests

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

payload = {
    "chatId": "79876543210@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": "79876543210@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