Listar mensagens

Este guia explica como usar o método list no recurso Message da a API Google Chat para conferir uma lista paginada e filtrável de mensagens em um espaço.

Na API Chat, uma mensagem do Chat é representada por Recurso Message. Os usuários do Chat só podem enviar mensagens com texto, Os apps de chat podem usar muitos outros recursos de mensagens, incluindo exibir interfaces do usuário estáticas ou interativas, coletar informações de usuários e na entrega de mensagens com privacidade. Para saber mais sobre mensagens recursos disponíveis para a API Chat, consulte o Visão geral das mensagens do Google Chat.

Pré-requisitos

Python

Listar mensagens

Para listar mensagens com autenticação do usuário transmita o seguinte na sua solicitação:

O exemplo a seguir lista as mensagens em um espaço do Chat enviadas depois de 16 de março de 2023:

Python

  1. No diretório de trabalho, crie um arquivo chamado chat_messages_list.py.

  2. Inclua o seguinte código em chat_messages_list.py:

    from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build

# Define your app's authorization scopes.
# When modifying these scopes, delete the file token.json, if it exists.
SCOPES = ["https://www.googleapis.com/auth/chat.messages.readonly"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then lists messages in a space sent after March 16, 2023.
    '''

    # Authenticate with Google Workspace
    # and get user authorization.
    flow = InstalledAppFlow.from_client_secrets_file(
                      'client_secrets.json', SCOPES)
    creds = flow.run_local_server()

    # Build a service endpoint for Chat API.
    chat = build('chat', 'v1', credentials=creds)

    # Use the service endpoint to call Chat API.
    result = chat.spaces().messages().list(

          # The space for which to list messages.
          parent = 'spaces/SPACE',

          # An optional filter that returns messages
          # created after March 16, 2023.
          filter = 'createTime > "2023-03-16T00:00:00-00:00"'

      ).execute()

    # Prints the list of messages.
    print(result)

if __name__ == '__main__':
    main()

  3. No código, substitua SPACE por um nome de espaço, que que você pode conseguir na Método spaces.list na API Chat ou pelo URL de um espaço.

  4. No diretório de trabalho, crie e execute o exemplo:

    python3 chat_messages_list.py

A API Chat retorna uma lista de mensagens enviadas no espaço especificado após 16 de março de 2023. Se não houver mensagens na solicitação, o A resposta da API Chat retorna um objeto vazio. Ao usar um REST/HTTP, a resposta contém um objeto JSON vazio, {}.