Search messages with the Google Chat API
Searches messages by keywords in every space and direct message of the user, latest first. Each result has the message, whose name carries the space and message ids; messages from Chat apps, private messages and muted spaces are left out.
- Identifier
- google_chat_search_messages
The request
POST https://connect.reportei.com/api/tools/google_chat_search_messages/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"filter": "<filter>"
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | Yes | Keywords, with quotes for an exact phrase, and optional conditions joined by AND: space.name = "spaces/AAAAAAAAAAA", space.display_name:Project, sender.name = "users/ana@example.com", attachment:*, has_link(), and create_time followed by a greater-than-or-equal or a less-than sign and an RFC 3339 timestamp in double quotes. Up to 1000 characters. |
| pageSize | integer | No | Results per page, up to 100. The default is 25. |
| pageToken | string | No | The nextPageToken of the previous response, with the same filter. |
Supported connections
Your customer connects their Google Chat account once, with one of the modes below. The same connection serves every tool of the toolkit.
OAuth with your product's app
You register your product's OAuth app once, with POST /api/merchants/credentials/google_chat, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/google_chat_search_messages. It becomes your agent's tool definition with no conversion.
Other Google Chat tools
- List spacesGETLists the spaces, group chats and direct messages the user is a member of, with name, displayName and spaceType. The part of the name after spaces/ is the spaceId of the other tools, and group chats and direct messages only show up after their first message.
- Get direct messageGETReturns the direct message space between the user and another person; the part of its name after spaces/ is the spaceId for Send message. Responds 404 when the two have no direct message yet, which Create space starts.
- Create spacePOSTCreates a space with the user in it and invites other people. SPACE needs displayName and takes up to 49 people; GROUP_CHAT takes at least two people and no name; DIRECT_MESSAGE takes exactly one person and returns the existing direct message when there is one.
- List messagesGETLists the messages of a space, oldest first by default, with name, sender, createTime, text and thread. Senders come as users/ followed by an id, without the display name; send nextPageToken as pageToken for the next page.
- Send messagePOSTSends a text message from the user to a space or direct message. To reply in a thread, send thread with the thread name from List messages and messageReplyOption; without messageReplyOption the message starts a new thread.
- Update messagePATCHChanges the text of a message, with updateMask set to text.
- Delete messageDELETEDeletes a message. A message with replies in a thread is only deleted with force set to true, which deletes the replies too.
- Create reactionPOSTAdds an emoji reaction from the user to a message.
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
