sendPoll

Отправляет опрос: вопрос и от 2 до 12 вариантов ответа. Удобно, чтобы выбрать время занятия или собрать мнение группы. Работает в Telegram — только в группах — и в WhatsApp.

Параметры

Пример запроса

Выбрать время занятия в группе Telegram:

curl

curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/sendPoll/$GRATIO_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
    "chatId": "-1001234567890",
    "message": "Когда удобнее перенести занятие?",
    "options": [
      {
        "optionName": "Суббота, 11:00"
      },
      {
        "optionName": "Воскресенье, 12:00"
      }
    ],
    "multipleAnswers": false,
    "clientMessageId": "poll-reschedule-nov"
  }'

Python

import os
import requests

BASE = f"{os.environ['GRATIO_URL']}/waInstance{os.environ['GRATIO_ID']}"
TOKEN = os.environ["GRATIO_TOKEN"]

url = f"{BASE}/sendPoll/{TOKEN}"
payload = {
    "chatId": "-1001234567890",
    "message": "Когда удобнее перенести занятие?",
    "options": [
        {"optionName": "Суббота, 11:00"},
        {"optionName": "Воскресенье, 12:00"},
    ],
    "multipleAnswers": False,
    "clientMessageId": "poll-reschedule-nov",
}
response = requests.post(url, json=payload, timeout=60)
print(response.status_code, response.json())

Node.js

const { GRATIO_URL, GRATIO_ID, GRATIO_TOKEN } = process.env;
const base = `${GRATIO_URL}/waInstance${GRATIO_ID}`;

const url = `${base}/sendPoll/${GRATIO_TOKEN}`;
const payload = {
  chatId: "-1001234567890",
  message: "Когда удобнее перенести занятие?",
  options: [
    { optionName: "Суббота, 11:00" },
    { optionName: "Воскресенье, 12:00" },
  ],
  multipleAnswers: false,
  clientMessageId: "poll-reschedule-nov",
};
const response = await fetch(url, {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify(payload),
});
console.log(response.status, await response.json());

PHP

<?php
$base = getenv('GRATIO_URL') . '/waInstance' . getenv('GRATIO_ID');
$url = $base . '/sendPoll/' . getenv('GRATIO_TOKEN');
$payload = [
    'chatId' => '-1001234567890',
    'message' => 'Когда удобнее перенести занятие?',
    'options' => [
        ['optionName' => 'Суббота, 11:00'],
        ['optionName' => 'Воскресенье, 12:00'],
    ],
    'multipleAnswers' => false,
    'clientMessageId' => 'poll-reschedule-nov',
];

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
    CURLOPT_POSTFIELDS => json_encode($payload, JSON_UNESCAPED_UNICODE),
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 60,
]);
$response = json_decode(curl_exec($ch), true);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), PHP_EOL;
print_r($response);

Пример ответа

Ответ 200 OK:

{"idMessage": "4815"}

После отправки приходят outgoingAPIMessageReceived с pollMessageData и статус outgoingMessageStatus sent.

Ещё примеры

Несколько ответов

Личный чат WhatsApp, можно выбрать несколько вариантов:

curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/sendPoll/$GRATIO_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
    "chatId": "79991234567@c.us",
    "message": "Какие направления интересны?",
    "options": [
      {
        "optionName": "Робототехника"
      },
      {
        "optionName": "Программирование"
      },
      {
        "optionName": "3D-моделирование"
      }
    ],
    "multipleAnswers": true
  }'

Ошибки

Особенности каналов

• Telegram. Опрос — только в группу: в личный чат Telegram его не пускает. Вопрос — до 255 символов, вариант — до 100: длиннее Gratio обрезает.
• WhatsApp. Опрос — в любой чат. Голос собеседника приходит уведомлением quotedMessage на опрос с выбранными вариантами текстом — см. Опрос.
• MAX и почта — 501 not_supported.

Что дальше

• Опрос — как приходят опросы и голоса.
• Группа для клиентов — опрос в группе как часть сценария.
• sendMessage — вопрос с вариантами текстом там, где опросов нет.