Chatfuel
Public API

Public API

Crie integrações com a API GraphQL do Chatfuel: tokens e usuários virtuais, requisições e erros, e uma referência de cada operação.

Última atualização

Crie integrações com a API GraphQL do Chatfuel: tokens e usuários virtuais, requisições e erros, e uma referência de cada operação.

Artigos desta seção

Autenticação e tokens da Public API

Envie um token de API pessoal (CLI token) ou um token de usuário virtual como token Bearer. Use usuários virtuais no dia a dia e o token pessoal para a conta.

Como fazer requisições à Public API

Envie requisições POST GraphQL para panel.chatfuel.com/graphql, pagine com cursores, assine eventos via WebSocket, envie arquivos e respeite os limites.

Erros e códigos de erro da Public API

Os erros da Public API chegam no array errors do GraphQL. Leia extensions.code, como Unauthorized ou NotEnoughPermissions, e guarde o traceId.

Guia de início rápido da Public API do Chatfuel

Crie um token de API pessoal, encontre o ID do bot, crie um usuário virtual e faça sua primeira consulta e mutação na Public API em cerca de dez minutos.

Referência da API de agendamentos e catálogo

Gerencie agendamentos, especialistas, produtos e serviços com a Public API: leia a agenda, crie e atualize horários e sincronize o Google Calendar.

Referência da API de arquivos e tarefas

Faça upload de arquivos, leia suas URLs e acompanhe tarefas longas, como exportações de contatos e sincronizações do Google Calendar, com getTask e taskUpdated.

Referência da API de canais

Leia os canais conectados de um bot e gerencie WhatsApp, Instagram, Facebook, TikTok e o widget do site. Conectar canais exige o token pessoal.

Referência da API de contatos

Pesquise, leia e atualize contatos do Chatfuel: atributos, nomes, notas, responsáveis e etapas de vendas, segmentos, importação e exportação CSV e eventos.

Referência da API de equipe e funções

Liste membros e convites, e crie, renove, mude a função ou remova usuários virtuais. Alterar a equipe exige o token de API pessoal de um Admin.

Referência da API de flows

Leia e crie flows do Chatfuel pela Public API: flows e grupos, blocos e conexões, componentes de mensagem e ação, regras de palavras-chave e Test chat.

Referência da API de Fuely AI e Automations

Configure o Fuely AI com a Public API: Automations e suas configurações, conhecimento da empresa, regras de agendamento e broadcasts do WhatsApp.

Referência da API de mensagens

Leia conversas e envie texto, anexos e templates do WhatsApp no WhatsApp, Instagram, Facebook, TikTok e no widget do site pela Public API.

Referência da API: bots e conta

Leia um bot e a conta atual com bot(id:) e currentUser. Renomear, excluir e criar bots e workspaces exige o token de API pessoal.

Usuários virtuais na Public API do Chatfuel

Um usuário virtual é um Editor ou Agent exclusivo da API em um bot, com token próprio. Crie, rotacione, mude a função e remova-o com seu token de API pessoal.

Versionamento e descontinuação da Public API

A Public API tem um único endpoint sem versão. Campos publicados nunca quebram: as mudanças são aditivas e remoções são antes marcadas como obsoletas.

Visão geral da Public API do Chatfuel

A Public API do Chatfuel é uma API GraphQL para gerenciar bots, contatos, mensagens e fluxos a partir do seu servidor, com tokens de usuários virtuais.