- Żądanie HTTP
- Parametry ścieżki
- Parametry zapytania
- Treść żądania
- Treść odpowiedzi
- Zakresy autoryzacji
- MessageReplyOption
- CreateMessageNotificationOptions
- NotificationType
- Wypróbuj
Tworzy wiadomość w pokoju czatu Google Chat. Przykład znajdziesz w sekcji 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.createhttps://www.googleapis.com/auth/chat.messageshttps://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 poniżej pokazuje, jak Google 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).
Poniższy obraz pokazuje, jak Google Chat przypisuje wiadomość, gdy używasz uwierzytelniania użytkownika. Google Chat wyświetla użytkownika jako nadawcę wiadomości i przypisuje aplikację do Google Chat do wiadomości, wyświetlając jej nazwę. Treść wiadomości może zawierać tylko tekst (text).
Maksymalny rozmiar wiadomości, w tym jej zawartości, to 32 000 bajtów.
W przypadku żądań webhooka odpowiedź nie zawiera pełnej wiadomości. Odpowiedź zawiera tylko pola name i thread.name oraz informacje, które były 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 |
Wymagane. Nazwa zasobu pokoju, w którym ma zostać utworzona wiadomość. Format: |
Parametry zapytania
| Parametry | |
|---|---|
threadKey |
Opcjonalnie: Wycofana: użyj zasady |
requestId |
Opcjonalnie: Unikalny identyfikator tej prośby. Zalecany jest losowy identyfikator UUID. Określenie identyfikatora żądania sprawia, że żądanie jest idempotentne, co gwarantuje, że wiele identycznych żądań z tym samym identyfikatorem żądania spowoduje utworzenie tylko jednej wiadomości. Kolejne żądania z tym samym identyfikatorem żądania zwracają istniejącą wiadomość i nie aktualizują jej, nawet jeśli żądane szczegóły różnią się od bieżącego stanu. Aby skutecznie korzystać z tego pola:
|
messageReplyOption |
Opcjonalnie: Określa, czy wiadomość rozpoczyna wątek, czy jest odpowiedzią w wątku. Ta funkcja jest obsługiwana tylko w pokojach nazwanych. To pole jest ignorowane podczas odpowiadania na interakcje użytkowników. 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 |
Opcjonalnie: Identyfikator niestandardowy wiadomości. Umożliwia aplikacjom do Google Chat pobieranie, aktualizowanie i usuwanie wiadomości bez konieczności przechowywania przypisanego przez system identyfikatora w nazwie zasobu wiadomości (reprezentowanej w polu wiadomości Wartość w tym polu musi spełniać te wymagania:
Więcej informacji znajdziesz w artykule Nadawanie nazwy wiadomości. |
createMessageNotificationOptions |
Opcjonalnie: Określa zachowanie powiadomień po opublikowaniu wiadomości. Więcej informacji znajdziesz w artykule Wymuszanie powiadomień i wysyłanie cichych 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 utworzone wystąpienie obiektu Message.
Zakresy autoryzacji
Wymaga jednego z tych zakresów OAuth:
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
Więcej informacji znajdziesz w przewodniku po autoryzacji.
MessageReplyOption
Określa, jak odpowiedzieć 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 parametrów thread ID i . |
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD |
Tworzy wiadomość jako odpowiedź w wątku określonym przez thread ID lub . Jeśli się nie uda, wiadomość rozpocznie nowy wątek. |
REPLY_MESSAGE_OR_FAIL |
Tworzy wiadomość jako odpowiedź w wątku określonym przez thread ID lub . Jeśli użyjesz nowego threadKey, zostanie utworzony nowy wątek. Jeśli nie uda się utworzyć wiadomości, zwracany jest błąd NOT_FOUND. |
CreateMessageNotificationOptions
Opcje zachowania powiadomienia po opublikowaniu wiadomości.
| Zapis JSON |
|---|
{
"notificationType": enum ( |
| Pola | |
|---|---|
notificationType |
Typ powiadomienia dotyczącego wiadomości. |
NotificationType
Opcje typów powiadomień dla wiadomości.
| Wartości w polu enum | |
|---|---|
NOTIFICATION_TYPE_NONE |
Działanie domyślne. Sposób działania powiadomień jest podobny do sytuacji, gdy użytkownik wysyła wiadomość za pomocą interfejsu Google Chat: do nadawcy nie jest wysyłane żadne powiadomienie. |
NOTIFICATION_TYPE_INCLUDE_HUMAN_CREATOR |
Do twórcy wiadomości (np. użytkownika, którego uwierzytelnienie zostało użyte do utworzenia wiadomości) wysyłane jest powiadomienie (powiadomienia push, powiadomienia e-mail itp.), a wiadomość jest oznaczana jako nieprzeczytana. Nie spowoduje to zastąpienia dotychczasowych ustawień powiadomień użytkowników w pokoju. Jeśli na przykład użytkownik nie chce otrzymywać powiadomień z pokoju, nie otrzyma ich, nawet jeśli ta opcja jest ustawiona. Wymaga uwierzytelniania użytkownika. |
NOTIFICATION_TYPE_FORCE_NOTIFY |
Wymuś powiadomienie odbiorców. Spowoduje to zignorowanie ustawień powiadomień w pokoju i ustawień trybu Nie przeszkadzać w Google Chat. Ta opcja nie pomija ustawień trybu Nie przeszkadzać na poziomie urządzenia. Wymaga uwierzytelniania aplikacji. |
NOTIFICATION_TYPE_SILENT |
Nie powiadamiaj odbiorców i nie oznaczaj wiadomości jako nieprzeczytanej. Działa to podobnie do wyciszenia rozmowy przez użytkownika lub włączenia opcji Nie przeszkadzać w Google Chat. Wymaga uwierzytelniania aplikacji. |