Tools do Chatwoot
As 15 operações do Chatwoot que o seu produto executa na conta do cliente pelo Connect. Todas usam o mesmo endpoint, POST /api/tools/{tool}/execute.
- Listar conversasGETLista 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.
- Criar conversaPOSTInicia uma conversa com um contato em uma caixa de entrada, opcionalmente com uma primeira mensagem. source_id identifica o contato nessa caixa: vem de contact_inboxes em Search contacts, de Create contact ou de Create contact inbox. Em caixas de WhatsApp, a primeira mensagem vai como template aprovado em message.template_params.
- Atualizar status da conversaPOSTDefine o status de uma conversa: open, resolved, pending ou snoozed. Sem snoozed_until, uma conversa em snoozed espera a próxima resposta do contato, e qualquer resposta do contato a reabre.
- Atribuir conversaPOSTAtribui uma conversa a um agente ou a um time. Quando assignee_id é enviado, team_id é ignorado.
- Atualizar etiquetas da conversaPOSTDefine as etiquetas de uma conversa. A lista enviada substitui as etiquetas atuais, então deve incluir as que devem ficar.
- Listar mensagensGETRetorna as últimas mensagens de uma conversa em ordem crescente, com meta contendo etiquetas, contato e responsável. sender_type diz quem enviou cada mensagem, e private marca notas internas. Para mensagens mais antigas, passe before com o id da mais antiga recebida.
- Criar mensagemPOSTEnvia uma mensagem em uma conversa. Uma mensagem de saída chega ao contato pelo canal da caixa de entrada, como WhatsApp, email ou widget do site; private true cria uma nota interna que só os agentes veem. No WhatsApp, template_params envia um template aprovado.
- Buscar contatosGETBusca 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.
- Criar contatoPOSTCria um contato em uma caixa de entrada da conta. A resposta traz o contato e o contact_inbox com o source_id de que Create conversation precisa.
- Atualizar contatoPUTAtualiza um contato: envie apenas os campos a alterar.
- Vincular contato a caixa de entradaPOSTVincula um contato existente a outra caixa de entrada e retorna o contact_inbox com seu source_id, para Create conversation quando o contato ainda não tem source_id nessa caixa.
- Listar caixas de entradaGETLista as caixas de entrada da conta, uma por canal, como WhatsApp, site, email ou API, com id, nome e channel_type. O id é o inbox_id de conversas e contatos.
- Listar agentesGETLista os agentes da conta com id, nome, email, função e availability_status. O id é o assignee_id de uma conversa.
- Listar timesGETLista os times da conta com id, nome e se o usuário da conexão é membro. O id é o team_id das conversas.
- Obter perfilGETRetorna o usuário conectado: id, nome, email e as contas a que pertence, cada uma com id, nome e função. O id de cada conta é o account_id que as outras tools pedem. O campo access_token da resposta vem mascarado.
Toolkits da mesma categoria
Ver os 100 toolkitsVeja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
