- Żądanie HTTP
- Parametry ścieżki
- Parametry zapytania
- Treść żądania
- Treść odpowiedzi
- Zakresy autoryzacji
- Wypróbuj
Wyświetla listę wiadomości z pokoju, do którego należy rozmówca, w tym wiadomości od zablokowanych użytkowników i pokoi. Jeśli wyświetlisz wiadomości z pokoju, w którym nie ma żadnych wiadomości, odpowiedź będzie pustym obiektem. Jeśli używasz interfejsu REST/HTTP, odpowiedź zawiera pusty obiekt JSON, {}
. Przykład: Wyświetlanie listy wiadomości. Wymaga uwierzytelniania użytkownika.
Żądanie HTTP
GET 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, z którego mają być wyświetlane wiadomości. Format: |
Parametry zapytania
Parametry | |
---|---|
pageSize |
Maksymalna liczba zwróconych wiadomości. Usługa może zwrócić mniej wiadomości niż ta wartość. Jeśli nie określono inaczej, zwracanych jest maksymalnie 25. Maksymalna wartość to 1000. Jeśli użyjesz wartości większej niż 1000, zostanie ona automatycznie zmieniona na 1000. Wartości ujemne zwracają błąd |
pageToken |
Opcjonalne, jeśli wznawiam działanie od poprzedniego zapytania. Token strony otrzymany z poprzedniego wywołania listy wiadomości. Podaj ten parametr, aby pobrać kolejną stronę. Podczas dzielenia na strony wszystkie pozostałe parametry powinny być zgodne z wywołaniem, które dostarczyło token strony. Przekazywanie innych wartości do innych parametrów może prowadzić do nieoczekiwanych wyników. |
filter |
Filtr zapytania. Wiadomości możesz filtrować według daty ( Aby filtrować wiadomości według daty ich utworzenia, wpisz Aby filtrować według wątku, podaj element Aby filtrować wyniki zarówno według wątku, jak i daty, użyj w zapytaniu operatora Prawidłowe są na przykład te zapytania:
Nieprawidłowe zapytania są odrzucane przez serwer z błędem |
orderBy |
Opcjonalne, jeśli wznawiam działanie od poprzedniego zapytania. Określ kolejność wyświetlania wiadomości. Określ wartość do zamówienia według operacji porządkowania. Prawidłowe wartości operacji porządkowania są następujące:
Domyślna kolejność to |
showDeleted |
Określa, czy uwzględniać usunięte wiadomości. Usunięte wiadomości zawierają informacje o czasie usunięcia i metadane dotyczące jego usunięcia, ale treść wiadomości jest niedostępna. |
Treść żądania
Treść żądania musi być pusta.
Treść odpowiedzi
Komunikat z odpowiedzią na listę wiadomości.
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{
"messages": [
{
object ( |
Pola | |
---|---|
messages[] |
Lista wiadomości. |
nextPageToken |
Aby pobrać następną stronę wyników, możesz wysłać token jako |
Zakresy autoryzacji
Wymaga jednego z tych zakresów protokołu OAuth:
https://www.googleapis.com/auth/chat.import
https://www.googleapis.com/auth/chat.messages
https://www.googleapis.com/auth/chat.messages.readonly
Więcej informacji znajdziesz w przewodniku na temat autoryzacji.