- HTTP-Anfrage
- Pfadparameter
- Suchparameter
- Anfragetext
- Antworttext
- Autorisierungsbereiche
- MessageReplyOption
- CreateMessageNotificationOptions
- NotificationType
- Testen!
Erstellt eine Nachricht in einem Google Chat-Bereich. Ein Beispiel finden Sie unter Nachricht senden.
Unterstützt die folgenden Arten der Authentifizierung:
- App-Authentifizierung mit dem Autorisierungsbereich:
https://www.googleapis.com/auth/chat.bot
- Nutzerauthentifizierung mit einem der folgenden Autorisierungsbereiche:
https://www.googleapis.com/auth/chat.messages.createhttps://www.googleapis.com/auth/chat.messageshttps://www.googleapis.com/auth/chat.import(nur Gruppenbereiche im Importmodus)
In Google Chat wird der Absender der Nachricht je nach Art der Authentifizierung, die Sie in Ihrer Anfrage verwenden, unterschiedlich zugeordnet.
Die folgende Abbildung zeigt, wie Chat eine Nachricht zuordnet, wenn Sie die App-Authentifizierung verwenden. In Google Chat wird die Chat-App als Absender der Nachricht angezeigt. Der Inhalt der Nachricht kann Text (text), Karten (cardsV2) und Zubehör-Widgets (accessoryWidgets) enthalten.
Die folgende Abbildung zeigt, wie Chat eine Nachricht zuordnet, wenn Sie die Nutzerauthentifizierung verwenden. In Google Chat wird der Nutzer als Absender der Nachricht angezeigt und die Chat-App wird der Nachricht zugeordnet, indem ihr Name angezeigt wird. Der Inhalt der Nachricht darf nur Text enthalten (text).
Die maximale Nachrichtengröße, einschließlich des Nachrichteninhalts, beträgt 32.000 Byte.
Bei Webhook-Anfragen enthält die Antwort nicht die vollständige Nachricht. In der Antwort werden zusätzlich zu den Informationen aus der Anfrage nur die Felder name und thread.name ausgefüllt.
HTTP-Anfrage
POST https://chat.googleapis.com/v1/{parent=spaces/*}/messages
Die URL verwendet die Syntax der gRPC-Transcodierung.
Pfadparameter
| Parameter | |
|---|---|
parent |
Erforderlich. Der Ressourcenname des Space, in dem eine Nachricht erstellt werden soll. Format: |
Suchparameter
| Parameter | |
|---|---|
threadKey |
Optional. Nicht mehr unterstützt: Verwenden Sie stattdessen |
requestId |
Optional. Eine eindeutige ID für diese Anfrage. Eine zufällige UUID wird empfohlen. Durch die Angabe einer Anfrage-ID wird die Anfrage idempotent. Dadurch wird sichergestellt, dass mehrere identische Anfragen mit derselben Anfrage-ID nur eine einzige Nachricht erstellen. Bei nachfolgenden Anfragen mit derselben Anfrage-ID wird die vorhandene Nachricht zurückgegeben und nicht aktualisiert, auch wenn sich die angeforderten Details vom aktuellen Status unterscheiden. So verwenden Sie dieses Feld effektiv:
|
messageReplyOption |
Optional. Gibt an, ob eine Nachricht einen Thread startet oder auf einen Thread antwortet. Wird nur in benannten Gruppenbereichen unterstützt. Wenn Sie auf Nutzerinteraktionen reagieren, wird dieses Feld ignoriert. Bei Interaktionen innerhalb eines Threads wird die Antwort im selben Thread erstellt. Andernfalls wird die Antwort als neuer Thread erstellt. |
messageId |
Optional. Eine benutzerdefinierte ID für eine Nachricht. Ermöglicht Chat-Apps, eine Nachricht abzurufen, zu aktualisieren oder zu löschen, ohne die vom System zugewiesene ID im Ressourcennamen der Nachricht (im Feld Der Wert für dieses Feld muss die folgenden Anforderungen erfüllen:
Weitere Informationen finden Sie unter Nachricht benennen. |
createMessageNotificationOptions |
Optional. Steuert das Benachrichtigungsverhalten, wenn die Nachricht gepostet wird. Weitere Informationen finden Sie unter Benachrichtigungen erzwingen oder lautlose Nachrichten senden. |
Anfragetext
Der Anfragetext enthält eine Instanz von Message.
Antworttext
Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine neu erstellte Instanz von Message.
Autorisierungsbereiche
Erfordert einen der folgenden OAuth-Bereiche:
https://www.googleapis.com/auth/chat.bothttps://www.googleapis.com/auth/chat.importhttps://www.googleapis.com/auth/chat.messageshttps://www.googleapis.com/auth/chat.messages.create
Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
MessageReplyOption
Gibt an, wie auf eine Nachricht geantwortet werden soll. In Zukunft werden möglicherweise weitere Bundesstaaten hinzugefügt.
| Enums | |
|---|---|
MESSAGE_REPLY_OPTION_UNSPECIFIED |
Standard. Startet einen neuen Thread. Wenn Sie diese Option verwenden, werden alle enthaltenen thread ID- oder -Werte ignoriert. |
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD |
Erstellt die Nachricht als Antwort auf den Thread, der durch thread ID oder angegeben ist. Wenn dies fehlschlägt, wird mit der Nachricht stattdessen ein neuer Thread gestartet. |
REPLY_MESSAGE_OR_FAIL |
Erstellt die Nachricht als Antwort auf den Thread, der durch thread ID oder angegeben ist. Wenn ein neuer threadKey verwendet wird, wird ein neuer Thread erstellt. Wenn die Nachrichtenerstellung fehlschlägt, wird stattdessen ein NOT_FOUND-Fehler zurückgegeben. |
CreateMessageNotificationOptions
Optionen für das Benachrichtigungsverhalten, wenn die Nachricht gepostet wird.
| JSON-Darstellung |
|---|
{
"notificationType": enum ( |
| Felder | |
|---|---|
notificationType |
Der Benachrichtigungstyp für die Nachricht. |
NotificationType
Die Optionen für die Benachrichtigungstypen für die Nachricht.
| Enums | |
|---|---|
NOTIFICATION_TYPE_NONE |
Standardverhalten. Das Benachrichtigungsverhalten ist ähnlich wie beim Senden der Nachricht über die Chat-Benutzeroberfläche: Der menschliche Absender erhält keine Benachrichtigung. |
NOTIFICATION_TYPE_INCLUDE_HUMAN_CREATOR |
Der Ersteller der Nachricht (z. B. der Nutzer, dessen Authentifizierung zum Erstellen der Nachricht verwendet wurde) erhält eine Benachrichtigung (Push-Benachrichtigung, E‑Mail-Benachrichtigung usw.) und die Nachricht wird als ungelesen markiert. Die vorhandenen Benachrichtigungseinstellungen der Nutzer für den Gruppenbereich werden dadurch nicht überschrieben. Wenn der Nutzer beispielsweise festgelegt hat, dass er für einen Gruppenbereich nicht benachrichtigt werden möchte, wird er auch dann nicht benachrichtigt, wenn diese Option aktiviert ist. Erfordert Nutzerauthentifizierung. |
NOTIFICATION_TYPE_FORCE_NOTIFY |
Erzwingen Sie die Benachrichtigung der Empfänger. Dadurch werden die Benachrichtigungseinstellungen für Gruppenbereiche und die Einstellungen für „Bitte nicht stören“ in Google Chat umgangen. Diese Option umgeht nicht die Einstellungen für „Bitte nicht stören“ auf Geräteebene. Erfordert eine App-Authentifizierung. |
NOTIFICATION_TYPE_SILENT |
Empfänger nicht benachrichtigen und die Nachricht nicht als ungelesen markieren. Das Verhalten ist ähnlich, wie wenn der Nutzer die Unterhaltung stummschaltet oder Bitte nicht stören in Google Chat aktiviert. Erfordert eine App-Authentifizierung. |