Method: spaces.messages.create

Tworzy wiadomość w pokoju czatu Google Chat. Przykład znajdziesz w artykule Wysyłanie wiadomości.

Obsługuje te typy uwierzytelniania:

  • Uwierzytelnianie aplikacji z zakresem autoryzacji:
    • https://www.googleapis.com/auth/chat.bot
  • Uwierzytelnianie użytkownika z jednym z tych zakresów autoryzacji:
    • https://www.googleapis.com/auth/chat.messages.create
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (tylko pokoje w trybie importowania)

Chat przypisuje nadawcę wiadomości w różny sposób w zależności od typu uwierzytelniania użytego w żądaniu.

Ilustracja pokazująca, jak Chat przypisuje wiadomość, gdy używasz uwierzytelniania aplikacji. Google Chat wyświetla aplikację Google Chat jako nadawcę wiadomości. Treść wiadomości może zawierać tekst (text), karty (cardsV2) i widżety dodatkowe (accessoryWidgets).

Wiadomość wysłana z uwierzytelnianiem aplikacji

Obraz poniżej pokazuje, jak Chat przypisuje wiadomość, gdy używasz uwierzytelniania użytkownika. Google Chat wyświetla użytkownika jako nadawcę wiadomości i przypisuje aplikację do obsługi czatu do wiadomości, wyświetlając jej nazwę. Treść wiadomości może zawierać tylko tekst (text).

Wiadomość wysłana z uwierzytelnianiem użytkownika

Maksymalny rozmiar wiadomości, w tym jej zawartość, to 32 000 bajtów.

W przypadku żądań webhooka odpowiedź nie zawiera pełnej wiadomości. Odpowiedź zawiera tylko pola namethread.name oraz informacje zawarte w żądaniu.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
parent

string

Wymagane. Nazwa zasobu pokoju, w którym ma zostać utworzona wiadomość.

Format: spaces/{space}

Parametry zapytania

Parametry
threadKey
(deprecated)

string

Opcjonalnie. Wycofana: zamiast niej używaj zasady thread.thread_key. Identyfikator wątku. Obsługuje do 4000 znaków. Aby rozpocząć wątek lub dodać do niego wiadomość, utwórz wiadomość i określ threadKey lub thread.name. Przykłady użycia znajdziesz w artykule Rozpoczynanie wątku wiadomości lub odpowiadanie w nim.

requestId

string

Opcjonalnie. Unikalny identyfikator żądania dla tej wiadomości. Określenie istniejącego identyfikatora żądania spowoduje zwrócenie wiadomości utworzonej za pomocą tego identyfikatora zamiast utworzenia nowej wiadomości.

messageReplyOption

enum (MessageReplyOption)

Opcjonalnie. Określa, czy wiadomość rozpoczyna wątek, czy jest odpowiedzią w wątku. Ta funkcja jest obsługiwana tylko w przypadku nazwanych pokoi.

Podczas odpowiadania na interakcje użytkownika to pole jest ignorowane. W przypadku interakcji w wątku odpowiedź jest tworzona w tym samym wątku. W przeciwnym razie odpowiedź zostanie utworzona jako nowy wątek.

messageId

string

Opcjonalnie. Niestandardowy identyfikator wiadomości. Umożliwia aplikacjom do obsługi czatu pobieranie, aktualizowanie i usuwanie wiadomości bez konieczności przechowywania identyfikatora przypisanego przez system w nazwie zasobu wiadomości (reprezentowanego w polu name wiadomości).

Wartość tego pola musi spełniać te wymagania:

  • Zaczyna się od client-. Na przykład client-custom-name jest prawidłowym identyfikatorem niestandardowym, ale custom-name już nie.
  • Zawiera maksymalnie 63 znaki, w tym tylko małe litery, cyfry i łączniki.
  • Jest unikalny w obrębie przestrzeni. Aplikacja do czatu nie może używać tego samego identyfikatora niestandardowego w przypadku różnych wiadomości.

Szczegółowe informacje znajdziesz w artykule Nadawanie nazwy wiadomości.

createMessageNotificationOptions

object (CreateMessageNotificationOptions)

Opcjonalnie. Określa sposób działania powiadomień po opublikowaniu wiadomości. Więcej informacji znajdziesz w artykule Wymuszanie powiadomień lub wysyłanie wyciszonych wiadomości.

Treść żądania

Treść żądania zawiera wystąpienie elementu Message.

Treść odpowiedzi

Jeśli operacja się uda, treść odpowiedzi będzie zawierała nowo utworzoną instancję Message.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • 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

Więcej informacji znajdziesz w przewodniku po autoryzacji.

MessageReplyOption

Określa sposób odpowiadania na wiadomość. W przyszłości możemy dodać więcej stanów.

Wartości w polu enum
MESSAGE_REPLY_OPTION_UNSPECIFIED Domyślny: Rozpoczyna nowy wątek. Użycie tej opcji powoduje zignorowanie wszystkich uwzględnionych elementów thread ID lub threadKey.
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD Tworzy wiadomość jako odpowiedź na wątek określony przez thread ID lub threadKey. Jeśli się nie uda, wiadomość rozpocznie nowy wątek.
REPLY_MESSAGE_OR_FAIL Tworzy wiadomość jako odpowiedź na wątek określony przez thread ID lub threadKey. Jeśli użyjesz nowego kodu threadKey, utworzysz nowy wątek. Jeśli utworzenie wiadomości się nie powiedzie, zamiast tego zwracany jest błąd NOT_FOUND.

CreateMessageNotificationOptions

Opcje dotyczące zachowania powiadomień po opublikowaniu wiadomości.

Zapis JSON
{
  "notificationType": enum (NotificationType)
}
Pola
notificationType

enum (NotificationType)

Typ powiadomienia o wiadomości.

NotificationType

Opcje typów powiadomień dla wiadomości.

Wartości w polu enum
NOTIFICATION_TYPE_NONE Domyślne zachowanie. Działanie powiadomień jest podobne do sytuacji, w której użytkownik wysyła wiadomość za pomocą interfejsu Google Chat: do użytkownika nie jest wysyłane żadne powiadomienie.
NOTIFICATION_TYPE_FORCE_NOTIFY

Wymuś powiadomienie odbiorców. Pomija to ustawienia powiadomień użytkowników w pokoju i ustawienia „Nie przeszkadzać” w Google Chat. Ta opcja nie ignoruje ustawień trybu Nie przeszkadzać na poziomie urządzenia.

Wymaga uwierzytelnienia aplikacji.

NOTIFICATION_TYPE_SILENT

Wycisz powiadomienie tak, jakby odbiorcy mieli włączoną funkcję Nie przeszkadzać na czacie lub wyciszyli pokój.

Wymaga uwierzytelnienia aplikacji.