Skip to Content
1MSG
Reference

Campaigns API

Campaigns API позволяет отправить одно сообщение многим получателям. В сегменте по умолчанию может быть до 500 человек. Чтобы поднять лимит до 10 000, напишите нам на [email protected]. Методы Inbox в этом документе не описаны.

Используйте группы методов в таком порядке: Segments → Campaigns → Analytics.

1. Сегменты

Создайте сегмент и добавьте участников. У каждого участника нужен name и хотя бы одно из полей phone или bsuid.

2. Рассылки

Создайте черновик с channelId, к которому у ключа API есть доступ, и segmentId из предыдущего шага.

Задайте content.mode — text или template:

  • Текст: передайте content.text.
  • Шаблон: передайте content.templateName и content.language (например, en).

Для шаблонов:

  • content.params в том же формате, что в sendTemplate, и уходит в WABA без изменений: поддерживаются картинки в шапке, переменные в тексте, кнопки и карточки карусели.
  • content.messageSendTtlSeconds необязателен и задаёт в секундах, сколько WhatsApp пытается доставить сообщение. Он стоит рядом с params, а не внутри компонентов шаблона.

Перед отправкой проверьте черновик через предпросмотр.

Чтобы запланировать рассылку, задайте в scheduledAt момент в будущем в ISO 8601 с Z или числовым смещением, например 2026-11-01T09:00:00Z. Чтобы начать отправку сразу, не передавайте его или передайте null.

Настройки количества сообщений в день нет. Шаблоны отправляются в пределах лимита канала, он возвращается в dailyLimit. Обычные сообщения внутри открытого окна 24 часа в этот лимит не входят.

3. Аналитика

После отправки смотрите аналитику, чтобы следить за результатами рассылки:

  • Общая статистика: сколько сообщений отправлено, доставлено, прочитано и сколько на них ответили.
  • Статистика по получателям: когда каждое сообщение отправлено, доставлено и прочитано, когда получатель ответил и что именно — включая нажатия кнопок и ответы текстом.
  • Статистика по кнопкам: кто и когда нажал каждую кнопку.
  • Статистика ошибок: у каких получателей были ошибки и какая ошибка у каждого номера.

4. Вебхуки рассылок

1MSG отправляет события на указанный HTTPS-адрес, когда сегменты или рассылки создаются или меняются и когда меняется статус рассылки.

Вебхуки настраиваются в Settings → Developer → Webhooks.

События

  • segment.created — создан сегмент. action равен segment_created.
  • segment.updated — изменился сегмент или его участники. action может быть segment_updated, segment_deleted, member_added, member_updated, member_deleted или members_replaced. По событию нельзя понять, какой именно участник изменился.
  • campaign.created — создан черновик рассылки. В scheduledAt — запланированное время отправки или null.
  • campaign.updated — изменён черновик рассылки. В scheduledAt — запланированное время отправки или null.
  • campaign.status_changed — статус рассылки сменился на draft, sending, pause, completed, failed или scheduled. В scheduledAt — запланированное время отправки или null.

Авторизация

У ключа должен быть доступ Campaigns. Ключ выдаётся в Settings → Developer → API key.

Authorization: Bearer 1msg_live_…

Segments

Создайте сегмент и добавьте людей. У каждого участника нужны имя и телефон в формате E.164 или BSUID.

Campaigns

Создайте черновик, задайте шаблон или текст, проверьте через предпросмотр, затем отправьте или запланируйте. Дневной лимит шаблонов — это лимит канала, а не поле рассылки.

Analytics

Данные по снимку отправки: до кого дошло, что ответили и почему отправка не прошла. conversationId — диалог в Inbox. providerConversationId — id чата у провайдера. messageId и providerMessageId — один и тот же id сообщения у провайдера.