跳转到主要内容
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 以调度;没有它,信息将立即发送。 后台工作人员在预定时间发送它,当 设备处于离线状态或未登录时重试 上传的媒体存储在 服务器上,直到计划完成为止。 在 multipart/form-data 请求体中,将 weekdays 作为重复字段发送 (weekdays=1、weekdays=3)。

phone
string
必填

发送投票的 WhatsApp 电话号码,包括'@s.whatsapp.net' 后缀。

示例:

"6289685024421@s.whatsapp.net"

question
string
必填
  1. 投票问题。
示例:

"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时区。 设置计划时必填。

示例:

"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)、776000(90d)。

示例:

86400

响应

好的

code
string
示例:

"SUCCESS"

message
string
示例:

"Success"

results
object