Обзор Messaging API v2

Messaging API v2 — это единая конечная точка REST/JSON для создания исходящих сообщений по всем каналам, которые поддерживает Pushwoosh:

Push-уведомления: iOS, Android, Huawei, Baidu, macOS, Amazon, Windows, Safari, Chrome, Firefox, IE
Email
SMS
Telegram, Kakao, LINE, WhatsApp

Канал выбирается по типу полезной нагрузки (payload для push-уведомлений / SMS / мессенджеров, email_payload для email).

Таргетинг выбирается по типу запроса (segment для сегментов аудитории, transactional для явных списков устройств или пользователей).

Базовый URL

https://api.pushwoosh.com

Если вы используете выделенный регион или частное развертывание, уточните точный базовый URL у вашего менеджера по работе с клиентами Pushwoosh.

Аутентификация

Каждый запрос должен содержать заголовок Authorization с серверным токеном доступа к API Pushwoosh:

Authorization: Token YOUR_API_TOKEN

Используйте тот же токен, который вы уже используете для API-вызовов “сервер-сервер”. Не раскрывайте этот токен в клиентских приложениях.

Методы

Notify: POST /messaging/v2/notify. Создание и отправка одного сообщения (сегментного или транзакционного).

Формат запроса и ответа

Тип контента: application/json.
Имена полей используют snake_case. Группы oneof отображаются как вложенные объекты с установленным ровно одним ключом.
Значения Enum сериализуются как их строковые имена (например, "IOS", "MESSAGE_TYPE_MARKETING").
Успешные ответы возвращают HTTP 200 с телом JSON; ошибки используют стандартную оболочку ошибок gRPC-Gateway — { "code": ..., "message": ..., "details": [...] }.

Быстрый старт

curl -X POST https://api.pushwoosh.com/messaging/v2/notify \
  -H "Authorization: Token YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "segment": {
      "application": "XXXXX-XXXXX",
      "platforms": ["IOS", "ANDROID"],
      "code": "active_users",
      "payload": {
        "content": {
          "localized_content": {
            "en": {
              "ios":     { "body": "Hello from v2!" },
              "android": { "body": "Hello from v2!" }
            }
          }
        }
      },
      "schedule": { "at": "2026-05-01T12:00:00Z" },
      "message_type": "MESSAGE_TYPE_MARKETING"
    }
  }'

Следующие шаги

Notify

Справочник по payload

Справочник по email payload

Миграция с v1