Übersicht über die Messaging API v2

Die Messaging API v2 ist ein einzelner REST/JSON-Endpunkt zum Erstellen ausgehender Nachrichten über jeden von Pushwoosh unterstützten Kanal:

Push: iOS, Android, Huawei, Baidu, macOS, Amazon, Windows, Safari, Chrome, Firefox, IE
E-Mail
SMS
Telegram, Kakao, LINE, WhatsApp

Der Kanal wird durch den Payload-Typ ausgewählt (payload für Push / SMS / Messenger, email_payload für E-Mail).

Das Targeting wird durch die Art der Anfrage ausgewählt (segment für Zielgruppensegmente, transactional für explizite Geräte- oder Benutzerlisten).

Basis-URL

https://api.pushwoosh.com

Wenn Sie eine dedizierte Region oder eine private Bereitstellung verwenden, bestätigen Sie die genaue Basis-URL mit Ihrem Pushwoosh Customer Success Manager.

Authentifizierung

Jede Anfrage muss einen Authorization-Header mit einem serverseitigen Pushwoosh API-Zugriffstoken enthalten:

Authorization: Token YOUR_API_TOKEN

Verwenden Sie dasselbe Token, das Sie bereits für Server-zu-Server-API-Aufrufe ausstellen. Geben Sie dieses Token nicht in Client-Anwendungen preis.

Methoden

Notify: POST /messaging/v2/notify. Erstellen und senden Sie eine einzelne Nachricht (Segment oder transaktional).

Anfrage- und Antwortformat

Inhaltstyp: application/json.
Feldnamen verwenden snake_case. oneof-Gruppen erscheinen als verschachtelte Objekte mit genau einem gesetzten Schlüssel.
Enum-Werte werden als ihre String-Namen serialisiert (zum Beispiel "IOS", "MESSAGE_TYPE_MARKETING").
Erfolgreiche Antworten geben HTTP 200 mit einem JSON-Body zurück; Fehler verwenden den Standard-gRPC-Gateway-Fehlerumschlag — { "code": ..., "message": ..., "details": [...] }.

Schnellstart

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"
    }
  }'

Nächste Schritte

Notify

Payload-Referenz

E-Mail-Payload-Referenz

Migration von v1