Method: spaces.messages.create

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.create
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (nur Gruppenbereiche im Importmodus)

Chat ordnet den Absender der Nachricht je nach Art der Authentifizierung in Ihrer Anfrage unterschiedlich zu.

Das folgende Bild 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.

Nachricht mit App-Authentifizierung gesendet

Das folgende Bild zeigt, wie Chat eine Nachricht zuordnet, wenn Sie die Nutzerauthentifizierung verwenden. Im Chat wird der Nutzer als Absender der Nachricht angezeigt und die Chat-App wird der Nachricht durch die Anzeige ihres Namens zugeordnet. Der Inhalt der Nachricht darf nur Text (text) enthalten.

Nachricht mit Nutzerauthentifizierung gesendet

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 nur die Felder name und thread.name zusätzlich zu den Informationen in der Anfrage ausgefüllt.

HTTP-Anfrage

POST https://chat.googleapis.com/v1/{parent=spaces/*}/messages

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Der Ressourcenname des Gruppenbereichs, in dem eine Nachricht erstellt werden soll.

Format: spaces/{space}

Suchparameter

Parameter
threadKey
(deprecated)

string

Optional. Nicht mehr unterstützt: Verwenden Sie stattdessen thread.thread_key. ID für den Thread. Es können bis zu 4.000 Zeichen eingegeben werden. Wenn Sie einen Thread starten oder ihm etwas hinzufügen möchten, erstellen Sie eine Nachricht und geben Sie ein threadKey oder das thread.name an. Beispiele für die Verwendung finden Sie unter Nachrichtenthread starten oder darauf antworten.
requestId

string

Optional. Eine eindeutige Anfrage-ID für diese Nachricht. Wenn Sie eine vorhandene Anforderungs-ID angeben, wird die mit dieser ID erstellte Nachricht zurückgegeben, anstatt eine neue Nachricht zu erstellen.
messageReplyOption

enum (MessageReplyOption)

Optional. Gibt an, ob mit einer Nachricht eine Unterhaltung gestartet oder auf eine Unterhaltung geantwortet wird. Wird nur in benannten Bereichen unterstützt.

Beim Reagieren auf Nutzerinteraktionen wird dieses Feld ignoriert. Bei Interaktionen in einem Thread wird die Antwort im selben Thread erstellt. Andernfalls wird die Antwort als neuer Thread erstellt.
messageId

string

Optional. Eine benutzerdefinierte ID für eine Nachricht. Mit dieser Funktion können Lets Chat-Apps Nachrichten abrufen, aktualisieren oder löschen, ohne die vom System zugewiesene ID im Ressourcennamen der Nachricht (im Feld name der Nachricht) speichern zu müssen.

Der Wert für dieses Feld muss die folgenden Anforderungen erfüllen:

  • Beginnt mit client-. Beispiel: client-custom-name ist eine gültige benutzerdefinierte ID, custom-name jedoch nicht.
  • Enthält bis zu 63 Zeichen und nur Kleinbuchstaben, Ziffern und Bindestriche.
  • Ist innerhalb eines Bereichs eindeutig. Eine Chat-App kann nicht dieselbe benutzerdefinierte ID für verschiedene Nachrichten verwenden.

Weitere Informationen
createMessageNotificationOptions

object (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.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.create

Weitere Informationen finden Sie im Autorisierungsleitfaden.

MessageReplyOption

Gibt an, wie auf eine Nachricht geantwortet werden soll. Möglicherweise werden in Zukunft 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 threadKey-Elemente ignoriert.
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD Erstellt die Nachricht als Antwort auf den Thread, der durch thread ID oder threadKey angegeben wird. Wenn das nicht möglich ist, 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 threadKey angegeben wird. 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 (NotificationType)
}
Felder
notificationType

enum (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 durch den menschlichen Nutzer über die Chat-Benutzeroberfläche: Der menschliche Absender erhält keine Benachrichtigung.
NOTIFICATION_TYPE_FORCE_NOTIFY

Empfänger benachrichtigen. Dadurch werden die Benachrichtigungseinstellungen für Gruppenbereiche und die „Bitte nicht stören“-Einstellungen für Chat der Nutzer umgangen. Mit dieser Option werden die Einstellungen für „Bitte nicht stören“ auf Geräteebene nicht umgangen.

Erfordert App-Authentifizierung.
NOTIFICATION_TYPE_SILENT

Die Benachrichtigung wird stummgeschaltet, als ob die Empfänger Chat – Bitte nicht stören aktiviert oder den Gruppenbereich stummgeschaltet hätten.

Erfordert App-Authentifizierung.