Stornieren

POST https://api.pushwoosh.com/messaging/v2/cancel

Storniert eine zuvor erstellte Nachricht, die durch ihren message_code identifiziert wird. Eine Stornierung ist nur möglich, während sich die Nachricht in einem dieser Zustände befindet:

pending: erstellt, aber noch nicht zum Senden abgeholt.
waiting: für einen zukünftigen Sendezeitpunkt geplant.
processing: wird gerade für die Zustellung vorbereitet.

Um zu überprüfen, ob eine Nachricht noch stornierbar ist, siehe Nachrichtenstatus überprüfen.

Anfrage

Authentifizieren Sie sich mit Ihrem Server-API-Token im Authorization: Token <API_TOKEN>-Header.

Feld	Typ	Erforderlich	Beschreibung
`message_code`	string	Ja	Nachrichtencode der zu stornierenden Nachricht, wie von `Notify` in `result.message_code` zurückgegeben.

Beispielanfrage

curl -X POST https://api.pushwoosh.com/messaging/v2/cancel \
  -H "Authorization: Token YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "message_code": "XXXX-XXXXXXXX-XXXXXXXX"
  }'

Antwort

Bei Erfolg wird HTTP 200 mit einem leeren JSON-Body zurückgegeben.

{}

Fehler

Fehler verwenden den standardmäßigen gRPC-Gateway-Fehlerumschlag: { "code": ..., "message": ..., "details": [...] }.

HTTP-Status	Bedingung
`400`	`message_code` fehlt.
`400`	Die Nachricht befindet sich nicht in einem stornierbaren Zustand (sie ist nicht mehr `pending`, `waiting` oder `processing`).
`403`	Die Nachricht gehört zu einem anderen Konto.
`404`	Für den angegebenen `message_code` existiert keine Nachricht.
`500`	Beim Laden der Nachricht oder Veröffentlichen der Stornierung ist ein interner Fehler aufgetreten. Versuchen Sie die Anfrage erneut.

Beispiel

Das Stornieren einer nicht mehr existierenden Nachricht gibt HTTP 404 zurück:

{
  "code": 5,
  "message": "message not found",
  "details": []
}

Nachrichtenstatus überprüfen

Vor dem Stornieren können Sie überprüfen, ob sich eine Nachricht noch in einem stornierbaren Zustand befindet. Neben dem Lesen der Spalte Status in der Nachrichtentabelle im Control Panel (Kampagnen → Einmalige Nachrichten) können Sie den Status auch programmgesteuert mit messages:list abfragen:

Übergeben Sie den message_code im Array filters.messages_codes (zusammen mit dem erforderlichen filters.application).
Lesen Sie das Feld status des passenden Eintrags in items[].