In diesem Dokument finden Sie eine Referenz für die HTTP-Syntax, die zum Übergeben von Nachrichten von Ihrem App-Server an Client-Apps über Firebase Cloud Messaging verwendet wird.
Wenn Sie das alte HTTP-Protokoll verwenden, muss Ihr App-Server alle HTTP-Anfragen an diesen Endpunkt weiterleiten:
https://fcm.googleapis.com/fcm/send
Die verfügbaren Parameter und Optionen lassen sich in die folgenden Kategorien unterteilen:
Syntax der Downstream-Nachricht
In diesem Abschnitt wird die Syntax zum Senden von Downstream-Nachrichten und zum Interpretieren von HTTP-Antworten von Firebase Cloud Messaging beschrieben.
Downstream-HTTP-Nachrichten (JSON)
In der folgenden Tabelle sind die Ziele, Optionen und Nutzlasten für HTTP-JSON-Nachrichten aufgeführt.
Parameter | Nutzung | Beschreibung | |
---|---|---|---|
Ziele | |||
to |
Optional, String |
Mit diesem Parameter wird der Empfänger einer Nachricht angegeben.
Der Wert kann das Registrierungstoken eines Geräts, der Benachrichtigungsschlüssel einer Gerätegruppe oder ein einzelnes Thema sein (mit dem Präfix |
|
registration_ids | Optional, Array von Strings |
Mit diesem Parameter wird der Empfänger einer Multicast-Nachricht angegeben, einer Nachricht, die an mehr als ein Registrierungstoken gesendet wird.
Der Wert sollte ein Array von Registrierungstokens sein, an die die Multicast-Nachricht gesendet werden soll. Das Array muss mindestens ein und höchstens 1.000 Registrierungstokens enthalten. Wenn Sie eine Nachricht an ein einzelnes Gerät senden möchten, verwenden Sie den Parameter Multicast-Nachrichten sind nur im HTTP-JSON-Format zulässig. |
|
condition |
Optional, String | Dieser Parameter gibt einen logischen Ausdruck von Bedingungen an, die das Nachrichtenziel bestimmen. Unterstützte Bedingung: „Thema“, formatiert als „'deinThema' in topics“. Bei diesem Wert wird die Groß- und Kleinschreibung nicht berücksichtigt. Unterstützte Operatoren: |
|
notification_key Eingestellt |
Optional, String | Dieser Parameter ist nicht mehr verfügbar. Verwenden Sie stattdessen |
|
Optionen | |||
collapse_key |
Optional, String | Mit diesem Parameter wird eine Gruppe von Nachrichten (z.B. mit Die Reihenfolge, in der Nachrichten gesendet werden, kann nicht garantiert werden. Hinweis: Es sind jeweils maximal vier verschiedene Minimierungsschaltflächen zulässig. Das bedeutet, dass FCM gleichzeitig vier verschiedene Nachrichten pro Client-App speichern kann. Wenn Sie diese Anzahl überschreiten, kann nicht garantiert werden, welche vier Minimierungsschlüssel FCM beibehält. |
|
priority |
Optional, String | Legt die Priorität der Nachricht fest. Gültige Werte sind „normal“ und „hoch“. Auf Apple-Plattformen entsprechen diese den APN-Prioritäten 5 und 10. Standardmäßig werden Benachrichtigungsnachrichten mit hoher Priorität und Datennachrichten mit normaler Priorität gesendet. Bei der normalen Priorität wird der Akkuverbrauch der Client-App optimiert. Diese Priorität sollte verwendet werden, es sei denn, eine sofortige Zustellung ist erforderlich. Bei Nachrichten mit normaler Priorität kann die App die Nachricht mit einer nicht näher bezeichneten Verzögerung erhalten. Wenn eine Nachricht mit hoher Priorität gesendet wird, wird sie sofort gesendet und die App kann eine Benachrichtigung anzeigen. |
|
content_available |
Optional, boolescher Wert | Verwenden Sie dieses Feld auf Apple-Plattformen, um |
|
mutable_content |
Optional, boolescher JSON-Wert | Verwenden Sie dieses Feld auf Apple-Plattformen, um |
|
time_to_live |
Optional, Zahl | Mit diesem Parameter wird angegeben, wie lange (in Sekunden) die Nachricht im FCM-Speicher aufbewahrt werden soll, wenn das Gerät offline ist. Die maximale Gültigkeitsdauer beträgt 4 Wochen und der Standardwert ist 4 Wochen. Weitere Informationen finden Sie unter Lebensdauer einer Nachricht festlegen. |
|
restricted_package_
(nur Android) |
Optional, String | Dieser Parameter gibt den Paketnamen der Anwendung an, mit der die Registrierungstokens übereinstimmen müssen, damit die Nachricht empfangen werden kann. | |
dry_run |
Optional, boolescher Wert | Wenn dieser Parameter auf Der Standardwert ist |
|
Nutzlast | |||
data |
Optional, Objekt | Mit diesem Parameter werden die benutzerdefinierten Schlüssel/Wert-Paare der Nutzlast der Nachricht angegeben. Beispiel: Wenn die Nachricht auf Apple-Plattformen über APNs gesendet wird, werden die benutzerdefinierten Datenfelder dargestellt. Wenn es über FCM gesendet wird, wird es in Unter Android würde dies zu einem Intent-Extra namens Der Schlüssel darf kein reserviertes Wort sein („from“, „message_type“ oder ein Wort, das mit „google“ oder „gcm“ beginnt). Verwenden Sie keine der in dieser Tabelle definierten Wörter (z. B. Werte in Stringtypen werden empfohlen. Sie müssen Werte in Objekten oder anderen Datentypen, die keine Strings sind (z.B. Ganzzahlen oder Boolesche Werte), in Strings konvertieren. |
|
notification |
Optional, Objekt | Dieser Parameter gibt die vordefinierten, für Nutzer sichtbaren Schlüssel/Wert-Paare der Benachrichtigungsnutzlast an. Weitere Informationen finden Sie unter „Unterstützung für Benachrichtigungsnutzlast“.
Weitere Informationen zu den Optionen für Benachrichtigungs- und Datennachrichten finden Sie unter
Nachrichtentypen. Wenn eine Benachrichtigungsnutzlast angegeben ist oder die Option content_available für eine Nachricht an ein Apple-Gerät auf true gesetzt ist, wird die Nachricht über APNs gesendet. Andernfalls wird sie über FCM gesendet.
|
Unterstützung für Benachrichtigungsnutzlasten
In den folgenden Tabellen sind die vordefinierten Schlüssel aufgeführt, die zum Erstellen von Benachrichtigungsnachrichten für iOS und Android verfügbar sind.
Parameter | Nutzung | Beschreibung |
---|---|---|
title |
Optional, String |
Der Titel der Benachrichtigung. Auf Smartphones und Tablets ist dieses Feld nicht sichtbar. |
body |
Optional, String |
Der Textkörper der Benachrichtigung. |
sound |
Optional, String |
Der Ton, der abgespielt wird, wenn das Gerät die Benachrichtigung erhält.
String, der Audiodateien im Hauptbundle der Client-App oder im Ordner |
badge |
Optional, String |
Der Wert des Logos auf dem App-Symbol auf dem Startbildschirm. Wird keine Angabe gemacht, ändert sich das Kennzeichen nicht.
Wenn Sie |
click_action |
Optional, String |
Die Aktion, die mit einem Nutzerklick auf die Benachrichtigung verknüpft ist.
Entspricht |
subtitle |
Optional, String |
Der Untertitel der Benachrichtigung. |
body_loc_key |
Optional, String |
Der Schlüssel für den Textkörper in den Stringressourcen der App, mit dem der Textkörper in die aktuelle Lokalisierung des Nutzers übersetzt wird.
Entspricht Weitere Informationen finden Sie unter Payload-Schlüsselreferenz und Inhalte von Remote-Benachrichtigungen lokalisieren. |
body_loc_args |
Optional, JSON-Array als String |
Variable Stringwerte, die anstelle der Formatanweisungen in
Entspricht Weitere Informationen finden Sie unter Payload-Schlüsselreferenz und Inhalte von Remote-Benachrichtigungen lokalisieren. |
title_loc_key |
Optional, String |
Der Schlüssel für den Titelstring in den Stringressourcen der App, mit dem der Titeltext in die aktuelle Lokalisierung des Nutzers übersetzt wird.
Entspricht Weitere Informationen finden Sie unter Payload-Schlüsselreferenz und Inhalte von Remote-Benachrichtigungen lokalisieren. |
title_loc_args |
Optional, JSON-Array als String |
Variable Stringwerte, die anstelle der Formatanweisungen in
Entspricht Weitere Informationen finden Sie unter Payload-Schlüsselreferenz und Inhalte von Remote-Benachrichtigungen lokalisieren. |
Parameter | Nutzung | Beschreibung |
---|---|---|
title |
Optional, String |
Der Titel der Benachrichtigung. |
body |
Optional, String |
Der Textkörper der Benachrichtigung. |
android_channel_id |
Optional, String |
Die Kanal-ID der Benachrichtigung (neu in Android O). Die App muss einen Kanal mit dieser Kanal-ID erstellen, bevor eine Benachrichtigung mit dieser Kanal-ID empfangen wird. Wenn du diese Kanal-ID nicht in der Anfrage sendest oder die angegebene Kanal-ID noch nicht von der App erstellt wurde, verwendet FCM die im App-Manifest angegebene Kanal-ID. |
icon |
Optional, String |
Das Symbol der Benachrichtigung.
Das Benachrichtigungssymbol wird für die Zeichnen-Ressource |
sound |
Optional, String |
Der Ton, der abgespielt wird, wenn das Gerät die Benachrichtigung erhält.
Unterstützt |
tag |
Optional, String |
Kennung, mit der vorhandene Benachrichtigungen in der Benachrichtigungsleiste ersetzt werden. Wenn nicht angegeben, wird für jede Anfrage eine neue Benachrichtigung erstellt. Wenn Sie ein Tag angeben und bereits eine Benachrichtigung mit demselben Tag angezeigt wird, ersetzt die neue Benachrichtigung die vorhandene im Benachrichtigungs-Schieberegler. |
color |
Optional, String |
Die Symbolfarbe der Benachrichtigung im |
click_action |
Optional, String |
Die Aktion, die mit einem Nutzerklick auf die Benachrichtigung verknüpft ist. Wenn angegeben, wird eine Aktivität mit einem übereinstimmenden Intent-Filter gestartet, wenn ein Nutzer auf die Benachrichtigung klickt. |
body_loc_key |
Optional, String |
Der Schlüssel für den Textkörper in den Stringressourcen der App, mit dem der Textkörper in die aktuelle Lokalisierung des Nutzers übersetzt wird. Weitere Informationen finden Sie unter Stringressourcen. |
body_loc_args |
Optional, JSON-Array als String |
Variable Stringwerte, die anstelle der Formatanweisungen in Weitere Informationen finden Sie unter Formatierung und Stil. |
title_loc_key |
Optional, String |
Der Schlüssel für den Titelstring in den Stringressourcen der App, mit dem der Titeltext in die aktuelle Lokalisierung des Nutzers übersetzt wird. Weitere Informationen finden Sie unter Stringressourcen. |
title_loc_args |
Optional, JSON-Array als String |
Variable Stringwerte, die anstelle der Formatanweisungen in Weitere Informationen finden Sie unter Formatierung und Stil. |
Parameter | Nutzung | Beschreibung |
---|---|---|
title |
Optional, String |
Der Titel der Benachrichtigung. |
body |
Optional, String |
Der Textkörper der Benachrichtigung. |
icon |
Optional, String |
Die URL für das Symbol der Benachrichtigung. |
click_action |
Optional, String |
Die Aktion, die mit einem Nutzerklick auf die Benachrichtigung verknüpft ist. Für alle URL-Werte ist HTTPS erforderlich. |
Downstream-HTTP-Nachrichten (Nur-Text)
In der folgenden Tabelle ist die Syntax für Ziele, Optionen und Nutzlast in einfachen Downstream-HTTP-Nachrichten aufgeführt.
Parameter | Nutzung | Beschreibung |
---|---|---|
Ziele | ||
registration_id |
Erforderlich, String | Mit diesem Parameter werden die Client-Apps (Registrierungstokens) angegeben, die die Nachricht empfangen. Multicast-Messaging (Senden an mehrere Registrierungstokens) ist nur im HTTP-JSON-Format zulässig. |
Optionen | ||
collapse_key |
Optional, String | Weitere Informationen finden Sie in Tabelle 1. |
time_to_live |
Optional, Zahl | Weitere Informationen finden Sie in Tabelle 1. |
restricted_package_name |
Optional, String | Weitere Informationen finden Sie in Tabelle 1. |
dry_run |
Optional, boolescher Wert | Weitere Informationen finden Sie in Tabelle 1. |
Nutzlast | ||
data.<key> |
Optional, String | Mit diesem Parameter werden die Schlüssel/Wert-Paare der Nutzlast der Nachricht angegeben. Die Anzahl der Schlüssel/Wert-Parameter ist nicht begrenzt, die Gesamtgröße der Nachricht ist jedoch auf 4.096 Byte beschränkt. Unter Android würde Der Schlüssel darf kein reserviertes Wort sein („from“, „message_type“ oder ein Wort, das mit „google“ oder „gcm“ beginnt). Verwenden Sie keine der in dieser Tabelle definierten Wörter (z. B. |
Antwort auf eine Downstream-Nachricht interpretieren
Der App-Server sollte sowohl den Antwortheader als auch den Antworttext der Nachricht auswerten, um die von FCM gesendete Antwort zu interpretieren. In der folgenden Tabelle werden die möglichen Antworten beschrieben.
Antwort | Beschreibung |
---|---|
200 | Die Nachricht wurde erfolgreich verarbeitet. Der Antworttext enthält weitere Details zum Nachrichtenstatus. Das Format hängt davon ab, ob die Anfrage im JSON- oder Nur-Text-Format war. Weitere Informationen finden Sie in Tabelle 5. |
400 | Gilt nur für JSON-Anfragen. Gibt an, dass die Anfrage nicht als JSON-Objekt geparst werden konnte oder ungültige Felder enthält (z. B. ein String, wo eine Zahl erwartet wurde). Der genaue Grund für den Fehler wird in der Antwort beschrieben. Das Problem muss behoben werden, bevor die Anfrage noch einmal versucht werden kann. |
401 | Bei der Authentifizierung des Absenderkontos ist ein Fehler aufgetreten. |
5xx | Fehler im Bereich 500–599 (z. B. 500 oder 503) weisen darauf hin, dass beim Versuch, die Anfrage zu verarbeiten, ein interner Fehler im FCM-Backend aufgetreten ist oder dass der Server vorübergehend nicht verfügbar ist (z. B. aufgrund von Zeitüberschreitungen). Der Absender muss später noch einmal versuchen, wobei er alle in der Antwort enthaltenen Retry-After -Header berücksichtigen muss. Anwendungsserver müssen einen exponentiellen Backoff implementieren. |
In der folgenden Tabelle sind die Felder in einem Downstream-Nachrichtenantwortkörper (JSON) aufgeführt.
Parameter | Nutzung | Beschreibung |
---|---|---|
multicast_id |
Erforderlich, Zahl | Eine eindeutige ID (Nummer), die die Multicast-Nachricht identifiziert. |
success |
Erforderlich, Zahl | Anzahl der Nachrichten, die ohne Fehler verarbeitet wurden. |
failure |
Erforderlich, Zahl | Anzahl der Nachrichten, die nicht verarbeitet werden konnten. |
results |
Erforderlich, Objekt-Array | Array von Objekten, die den Status der verarbeiteten Nachrichten darstellen. Die Objekte werden in derselben Reihenfolge wie in der Anfrage aufgeführt. Das heißt, für jede Registrierungs-ID in der Anfrage wird das Ergebnis in der Antwort unter derselben Indexposition aufgeführt.
|
Parameter | Nutzung | Beschreibung |
---|---|---|
message_id |
Optional, Zahl | Die Nachrichten-ID des Themas, wenn FCM die Anfrage erfolgreich empfangen hat und versucht, sie an alle abonnierten Geräte zu senden. |
error |
Optional, String | Fehler, der bei der Verarbeitung der Nachricht aufgetreten ist. Die möglichen Werte finden Sie in Tabelle 9. |
Parameter | Nutzung | Beschreibung |
---|---|---|
id |
Erforderlich, String | Dieser Parameter gibt die eindeutige Nachrichten-ID FCM an, die erfolgreich verarbeitet wurde. |
registration_id |
Optional, String | Dieser Parameter gibt das Registrierungstoken für die Client-App an, für die die Nachricht verarbeitet und gesendet wurde. |
Parameter | Nutzung | Beschreibung |
---|---|---|
Error |
Erforderlich, String | Dieser Parameter gibt den Fehlerwert an, der bei der Verarbeitung der Nachricht für den Empfänger aufgetreten ist. Weitere Informationen finden Sie in Tabelle 9. |
Fehlerantwortcodes für Downstream-Nachrichten
In der folgenden Tabelle sind die Fehlerantwortcodes für Downstream-Nachrichten aufgeführt.
Fehler | HTTP-Code | Empfohlene Maßnahme |
---|---|---|
Fehlendes Registrierungstoken | 200 + error:MissingRegistration | Prüfe, ob die Anfrage ein Registrierungstoken enthält (in registration_id in einer Nur-Text-Nachricht oder im Feld to oder registration_ids in JSON). |
Ungültiges Registrierungstoken | 200 + error:InvalidRegistration | Prüfe das Format des Registrierungstokens, das du an den Server übergibst. Es muss mit dem Registrierungstoken übereinstimmen, das die Client-App bei der Registrierung bei Firebase Notifications erhält. Kürzen Sie den Text nicht und fügen Sie keine zusätzlichen Zeichen hinzu. |
Nicht registriertes Gerät | 200 + error:NotRegistered | Ein vorhandenes Registrierungstoken kann in einer Reihe von Fällen ungültig werden, z. B.:
|
Ungültiger Paketname | 200 + error:InvalidPackageName | Prüfen Sie, ob die Nachricht an ein Registrierungstoken adressiert ist, dessen Paketname mit dem in der Anfrage übergebenen Wert übereinstimmt. |
Authentifizierungsfehler | 401 | Das Absenderkonto, über das eine Nachricht gesendet wurde, konnte nicht authentifiziert werden. Mögliche Ursachen:
|
Nicht übereinstimmender Absender | 200 + error:MismatchSenderId | Ein Registrierungstoken ist mit einer bestimmten Gruppe von Absendern verknüpft. Wenn eine Client-App für FCM registriert wird, muss sie angeben, welche Absender Nachrichten senden dürfen. Sie sollten eine dieser Absender-IDs verwenden, wenn Sie Nachrichten an die Client-App senden. Wenn Sie zu einem anderen Absender wechseln, funktionieren die vorhandenen Registrierungstokens nicht. |
Ungültiges JSON-Format | 400 | Prüfen Sie, ob die JSON-Nachricht richtig formatiert ist und gültige Felder enthält. Achten Sie beispielsweise darauf, dass der richtige Datentyp übergeben wird. |
Ungültige Parameter | 400 + error:InvalidParameters | Prüfen Sie, ob die angegebenen Parameter den richtigen Namen und Typ haben. |
Nachricht zu groß | 200 + error:MessageTooBig | Prüfen Sie, ob die Gesamtgröße der Nutzlastdaten in einer Nachricht die FCM-Grenzwerte nicht überschreitet: 4.096 Byte für die meisten Nachrichten oder 2.048 Byte bei Nachrichten an Themen. Das gilt sowohl für die Schlüssel als auch für die Werte. |
Ungültiger Datenschlüssel | 200 + Fehler:
InvalidDataKey |
Prüfen Sie, ob die Nutzlastdaten keinen Schlüssel (z. B. from , gcm oder einen Wert mit dem Präfix google ) enthalten, der intern von FCM verwendet wird. Einige Wörter (z. B. collapse_key ) werden auch von FCM verwendet, sind aber in der Nutzlast zulässig. In diesem Fall wird der Nutzlastwert vom FCM-Wert überschrieben. |
Ungültige Gültigkeitsdauer | 200 + error:InvalidTtl | Prüfen Sie,ob der in time_to_live verwendete Wert eine Ganzzahl ist,die eine Dauer in Sekunden zwischen 0 und 2.419.200 (4 Wochen) darstellt. |
Zeitlimit | 5xx- oder 200+-Fehler:Nicht verfügbar | Der Server konnte die Anfrage nicht rechtzeitig verarbeiten. Wiederholen Sie dieselbe Anfrage. Beachten Sie dabei Folgendes:
Absender, die Probleme verursachen, laufen Gefahr, auf die Sperrliste gesetzt zu werden. |
Interner Serverfehler | 500 oder 200 + error:InternalServerError | Beim Verarbeiten der Anfrage ist ein Fehler aufgetreten. Sie können dieselbe Anfrage unter Berücksichtigung der Anforderungen unter „Zeitüberschreitung“ (siehe Zeile oben) noch einmal versuchen. Wenn der Fehler weiterhin auftritt, wenden Sie sich bitte an den Firebase-Support. |
Gerätenachrichtenrate überschritten | 200 + Fehler:
DeviceMessageRate Exceeded |
Die Anzahl der Nachrichten an ein bestimmtes Gerät ist zu hoch. Wenn eine Apple-App Nachrichten mit einer Rate sendet, die die APN-Limits überschreitet, wird möglicherweise diese Fehlermeldung ausgegeben. Reduziere die Anzahl der an dieses Gerät gesendeten Nachrichten und verwende exponentielles Backoff, um den Versand zu wiederholen. |
Nachrichtenrate für Themen überschritten | 200 + Fehler:
TopicsMessageRate Exceeded |
Die Anzahl der Nachrichten an Abonnenten eines bestimmten Themas ist zu hoch. Reduziere die Anzahl der für dieses Thema gesendeten Nachrichten und verwende exponentielles Backoff, um den Versand zu wiederholen. |
Ungültige APNs-Anmeldedaten | 200 + Fehler:
InvalidApnsCredential |
Eine Nachricht, die an ein Apple-Gerät gesendet werden sollte, konnte nicht gesendet werden, da der erforderliche APNs-Authentifizierungsschlüssel nicht hochgeladen wurde oder abgelaufen ist. Prüfen Sie die Gültigkeit Ihrer Entwicklungs- und Produktionsanmeldedaten. |
Gerätegruppenverwaltung
In der folgenden Tabelle sind die Schlüssel zum Erstellen von Gerätegruppen sowie zum Hinzufügen und Entfernen von Mitgliedern aufgeführt. Weitere Informationen finden Sie im Leitfaden für Ihre Plattform: iOS + oder Android.
Parameter | Nutzung | Beschreibung |
---|---|---|
operation |
Erforderlich, String | Der auszuführende Vorgang.Gültige Werte sind create , add und remove . |
notification_key_name |
Erforderlich, String | Der benutzerdefinierte Name der zu erstellenden oder zu ändernden Gerätegruppe. |
notification_key |
Erforderlich (außer für den create -Vorgang, String |
Die eindeutige Kennung der Gerätegruppe. Dieser Wert wird in der Antwort für einen erfolgreichen create -Vorgang zurückgegeben und ist für alle nachfolgenden Vorgänge für die Gerätegruppe erforderlich. |
registration_ids |
Erforderlich, Array von Strings | Die Gerätetokens, die hinzugefügt oder entfernt werden sollen. Wenn Sie alle vorhandenen Registrierungstokens aus einer Gerätegruppe entfernen, löscht FCM die Gerätegruppe. |