Broadcast (mass delivery)
Send a message to all subscribers or a segment.
POST /v1/broadcast
Creates a broadcast job. Messages are sent through a queue.
text string requiredMessage text
format string Text format: plain (default), markdown, or html
media object Media object: {type, url}. Types: photo, video, document
buttons array Array of button rows: [[{text, url}]] or [[{text, callback_data}]]
permission string Filter by permission
tags array Filter by tags: ["vip", "beta"]
POST /v1/broadcast
{
"text": "Version 2.0 available!",
"permission": "updates",
"tags": ["beta"]
}
Response
{
"job_id": "a1b2c3d4-e5f6-...",
"status": "pending",
"total_subscribers": 1500
}
GET /v1/broadcast/:job_id
Get broadcast status.
Response fields: status (pending/processing/completed/failed), total, sent, failed.
{
"job_id": "b7f3...",
"status": "completed",
"total": 2847,
"sent": 2835,
"failed": 12
}