Skip to content

Visão geral

A API da Interleads Chat é uma API REST que permite operar a sua conta a partir do seu próprio sistema: gerenciar contatos, abrir conversas, enviar e receber mensagens, agendar envios e movimentar o seu funil de vendas (Kanban) — tudo por HTTP, com respostas em JSON.

É a mesma superfície que o painel usa. Se dá para fazer pela tela, na prática dá para automatizar pela API.

URL base

Todas as chamadas usam a base:

https://appchat01.interleads.chat

Use o host appchat01

app.interleads.chat responde com um redirecionamento 301. Um 301 faz o cliente HTTP repetir a requisição perdendo o corpo em métodos POST/PUT/PATCH — ou seja, o envio "some". Sempre aponte os seus scripts para https://appchat01.interleads.chat.

Escopo por conta

Quase todos os recursos ficam dentro de uma conta. O caminho começa sempre com o ID numérico da sua conta:

/api/v1/accounts/{account_id}/...

Por exemplo, listar conversas da conta 3:

GET https://appchat01.interleads.chat/api/v1/accounts/3/conversations

Onde achar o account_id: ele aparece na URL do painel quando você está logado — .../app/accounts/{account_id}/....

Autenticação em uma linha

Toda requisição leva o cabeçalho api_access_token com o seu token de acesso. Não é Bearer, não é OAuth — é o token direto no cabeçalho:

bash
curl "https://appchat01.interleads.chat/api/v1/accounts/3/conversations" \
  -H "api_access_token: SEU_TOKEN"

Detalhes de onde pegar o token e boas práticas em Autenticação.

Recursos disponíveis

ÁreaO que dá para fazer
ContatosCriar, buscar, atualizar e organizar contatos
ConversasAbrir conversas, atribuir agentes, mudar status e prioridade
MensagensEnviar mensagens ao cliente, criar notas internas, listar histórico
InboxesListar e configurar caixas de entrada (canais) e seus agentes
Agentes e TimesGerenciar agentes da conta e organizar times
LabelsCriar etiquetas e aplicá-las a conversas e contatos
Mensagens agendadasProgramar envios pontuais ou recorrentes
KanbanFunis, cards, etapas, atribuição e relatórios do pipeline

Convenções

  • Formato: requisições e respostas em JSON (UTF-8). Em POST/PUT/PATCH com corpo JSON, envie o cabeçalho Content-Type: application/json.
  • Datas: sempre em ISO 8601 em UTC — ex.: 2026-02-06T15:00:00Z.
  • IDs: inteiros. {account_id}, {conversation_id}, etc. são sempre numéricos.
  • Paginação: listas grandes são paginadas — veja Paginação.
  • Erros: códigos HTTP padrão + corpo JSON com a mensagem — veja Códigos de erro.

Próximos passos

  1. Autenticação — pegue o seu token.
  2. Início rápido — faça a primeira chamada e envie uma mensagem.

Documentação da API — Interleads Chat.