Buscar contatos no Chatwoot, por uma API

Busca os contatos que têm identificador, email ou telefone, por nome, identificador, email ou número de telefone, 15 por página. Cada contato traz contact_inboxes, que liga cada caixa ao source_id de que Create conversation precisa. meta.count é o total; uma página com menos de 15 contatos é a última.

Identificador
chatwoot_search_contacts

A chamada

POST https://connect.reportei.com/api/tools/chatwoot_search_contacts/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.
qstringNãoText matched against the name, identifier, email or phone number of the contact.
sortstringNãoSort field; a leading minus sorts in descending order.Valores: name, email, phone_number, last_activity_at, -name, -email, -phone_number, -last_activity_at
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_search_contacts. 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.