List messages

Python

• A Business or Enterprise Google Workspace account with access to Google Chat.

• Python 3.6 or greater
• The pip package management tool
• The latest Google client libraries. To install or update them, run the following command in your command-line interface:

  pip3 install --upgrade google-api-python-client google-auth-oauthlib
  

• Set up your environment:
  • Create a Google Cloud project.
  • Configure the OAuth consent screen.
  • Enable and configure the Google Chat API with a name, icon, and description for your Chat app.
  • Create OAuth client ID credentials for a desktop application. To run the sample in this guide, save the credentials as a JSON file (client_secrets.json) to your local directory.
  For guidance, complete the steps for setting up your environment in this quickstart.
• Choose an authorization scope that supports user authentication.

Python

1. In your working directory, create a file named chat_messages_list.py.

2. Include the following code in 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. In the code, replace SPACE with a space name, which you can obtain from the spaces.list method in the Chat API, or from a space's URL.

4. In your working directory, build and run the sample:

   python3 chat_messages_list.py