Listar mensagens no Gmail, por uma API

Lista as mensagens da caixa que correspondem a q e labelIds. Cada item tem apenas id e threadId: leia o conteúdo com Get message. Envie nextPageToken como pageToken para ler a próxima página.

Identificador
gmail_list_messages

A chamada

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>"
  }
}

Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.

Parâmetros

As descrições dos parâmetros seguem a documentação oficial do app, em inglês.

ParâmetroTipoObrigatórioDescrição
qstringNãoSearch 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.
labelIdsarrayNãoOnly messages that have all these labels: ids from List labels, or system labels such as INBOX, UNREAD and STARRED.
includeSpamTrashbooleanNãoAlso returns the messages in SPAM and TRASH. The default is false.
maxResultsintegerNãoMessages per page, up to 500. The default is 100.
pageTokenstringNãoThe nextPageToken of the previous response.

Conexões possíveis

O seu cliente conecta a conta do Gmail uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.

OAuth com o app do seu produto

Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/gmail, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.

A resposta

Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.

Pronta para agentes de IA

O input desta tool é um JSON Schema, disponível em GET /api/tools/gmail_list_messages. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Gmail

Ver as 12 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.