Перейти к основному содержанию
POST
Отправить опрос / проголосовать

Авторизации

Authorization
string
header
обязательно

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Заголовки

X-Device-Id
string

Идентификатор устройства для поддержки нескольких устройств. Требуется при регистрации нескольких устройств. Если только одно устройство зарегистрировано, оно будет использоваться по умолчанию. Можно также задать параметр device_id запроса.

Пример:

"my-device-id"

Тело

application/json

Необязательные поля, которые планируют сообщение вместо отправки его сейчас. Задайте scheduled_at для отложенной отправки; без этого параметра сообщение отправляется немедленно. Фоновый работник отправляет его в запланированное время, повтор, пока устройство не подключено или не авторизовано. Загруженные файлы хранятся на сервере до окончания графика. В многократных/формальных телах отправьте weekdays как повторяющееся поле (weekdays=1, weekdays=3).

phone
string
обязательно

Номер телефона WhatsApp для отправки опроса, включая суффикс '@s.whatsapp.net'.

Пример:

"6289685024421@s.whatsapp.net"

question
string
обязательно

Вопрос для опроса.

Пример:

"Siapa Nama Avatar The Last Air Bender?"

options
string[]
обязательно

Количество вариантов опроса.

Пример:
max_answer
integer
обязательно

Максимальное количество разрешенных ответов для опроса.

Пример:

2

scheduled_at
string<date-time>

RFC3339 время первого отправления. Должен быть в будущем. Первая отправка всегда происходит в данный момент, даже если она находится за пределами weekdays или day_of_month; она устанавливает следующие повторы.

Пример:

"2026-10-01T09:00:00+07:00"

timezone
string

Часовой пояс IANA, используемый для вычисления повторяющихся запусков. Требуется, если scheduled_at установлен.

Пример:

"Asia/Jakarta"

recurrence
enum<string>
по умолчанию:once

Как часто повторять отправку

Доступные опции:
once,
daily,
weekly,
monthly
weekdays
integer[]

Дней для отправки, 0=Воскресенье - 6=Суббота. Требуется, когда повторение проводится еженедельно.

Требуемый диапазон: 0 <= x <= 6
Пример:
day_of_month
integer

День месяца, привязанный к прошлому дню месяца. Требуется, когда повторение проводится ежемесячно.

Требуемый диапазон: 1 <= x <= 31
Пример:

15

end_at
string<date-time>

Только повтор. По прошествии этого времени не отправляется; необходимо по расписанию_ам.

Пример:

"2026-12-31T23:59:59+07:00"

occurrence_limit
integer

Только повтор. Остановиться после этого много отправлений.

Требуемый диапазон: x >= 1
Пример:

10

duration
integer

Длительность исходящего сообщения в секундах. Допустимые значения: 0 (нет срока), 86400 (24h), 604800 (7d), 7776000 (90d).

Пример:

86400

Ответ

ОК

code
string
Пример:

"SUCCESS"

message
string
Пример:

"Success"

results
object