Listar mensajes en Gmail, con una API

Lista los mensajes del buzón que coinciden con q y labelIds. Cada elemento tiene solo id y threadId: lee el contenido con Get message. Envía nextPageToken como pageToken para leer la página siguiente.

Identificador
gmail_list_messages

La llamada

POST https://connect.reportei.com/api/tools/gmail_list_messages/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "q": "<q>"
  }
}

Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.

Parámetros

Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.

ParámetroTipoObligatorioDescripción
qstringNoSearch query in the syntax of the Gmail search box, such as from:ana@example.com is:unread newer_than:7d or subject:invoice has:attachment.
labelIdsarrayNoOnly messages that have all these labels: ids from List labels, or system labels such as INBOX, UNREAD and STARRED.
includeSpamTrashbooleanNoAlso returns the messages in SPAM and TRASH. The default is false.
maxResultsintegerNoMessages per page, up to 500. The default is 100.
pageTokenstringNoThe nextPageToken of the previous response.

Conexiones posibles

Tu cliente conecta su cuenta de Gmail una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.

OAuth con la app de tu producto

Registras la app OAuth de tu producto una sola vez, con POST /api/merchants/credentials/gmail, y tu cliente autoriza la cuenta en una pantalla de consentimiento. Connect renueva el token cuando está por vencer.

La respuesta

Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.

Lista para agentes de IA

El input de esta tool es un JSON Schema, disponible en GET /api/tools/gmail_list_messages. Se convierte en la definición de tool de tu agente sin conversión.

Otras tools de Gmail

Ver las 12 tools

Toolkits de la misma categoría

Ver los 100 toolkits

Mira Connect aplicado a tu producto.

Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.