Listar conversas no Chatwoot, por uma API

Lista as conversas de uma conta, por padrão as abertas, com status, etiquetas, inbox_id, can_reply, o contato em meta.sender, o responsável e a última mensagem. data.meta traz as contagens por tipo de responsável. As páginas começam em 1; um payload vazio significa que não há mais páginas.

Identificador
chatwoot_list_conversations

A chamada

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "account_id": 1
  }
}

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
account_idintegerSimId of the Chatwoot account: the id of one of the accounts from Get profile, also shown in the dashboard URL after /accounts/, as in app.chatwoot.com/app/accounts/123.
statusstringNãoOnly conversations with this status. The default is open.Valores: all, open, resolved, pending, snoozed
assignee_typestringNãoOnly conversations assigned to the user of the connection, unassigned, assigned to anyone, or all (the default).Valores: me, unassigned, all, assigned
qstringNãoOnly conversations with messages containing this text.
inbox_idintegerNãoOnly conversations of this inbox, from List inboxes.
team_idintegerNãoOnly conversations of this team, from List teams.
labelsstringNãoOnly conversations with this label. One label per call.
pageintegerNãoPage number, starting at 1.

Conexões possíveis

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

Chave de API

O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.

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/chatwoot_list_conversations. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Chatwoot

Ver as 15 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.