Skip to content

Início rápido

Em poucos minutos você vai: testar o token, criar um contato, abrir uma conversa e enviar a primeira mensagem. Todos os exemplos usam a conta 3 — troque pelo seu account_id.

Antes de começar

Você vai precisar de três coisas:

O quêOnde achar
TokenPerfil → Token de Acesso — veja Autenticação
account_idNa URL do painel (/app/accounts/{id}/...)
inbox_idListe com GET /inboxes — veja Inboxes

Para não repetir o token, exporte-o como variável de ambiente:

bash
export INTERLEADS_TOKEN="seu_token_aqui"

1. Teste o token

Uma leitura simples confirma que o token e a conta estão certos:

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

Resposta 200 OK (mesmo que a lista venha vazia) = tudo certo. Se vier 401, revise a Autenticação.

2. Descubra um inbox

Você precisa de um inbox_id (o canal por onde a mensagem sai). Liste os seus:

bash
curl "https://appchat01.interleads.chat/api/v1/accounts/3/inboxes" \
  -H "api_access_token: $INTERLEADS_TOKEN"

Anote o id do inbox que quer usar. Nos exemplos abaixo usamos inbox_id = 5.

3. Crie um contato

bash
curl -X POST "https://appchat01.interleads.chat/api/v1/accounts/3/contacts" \
  -H "api_access_token: $INTERLEADS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "inbox_id": 5,
    "name": "João Silva",
    "phone_number": "+5511999998888"
  }'
js
const res = await fetch(
  "https://appchat01.interleads.chat/api/v1/accounts/3/contacts",
  {
    method: "POST",
    headers: {
      api_access_token: process.env.INTERLEADS_TOKEN,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      inbox_id: 5,
      name: "João Silva",
      phone_number: "+5511999998888",
    }),
  }
)
const contato = await res.json()

Guarde dois valores da resposta:

  • id do contato (contact_id) — usado no próximo passo;
  • source_id do contact_inbox criado — obrigatório para abrir a conversa.

4. Abra uma conversa

O source_id identifica o contato dentro daquele inbox (para WhatsApp, é o número no formato internacional).

bash
curl -X POST "https://appchat01.interleads.chat/api/v1/accounts/3/conversations" \
  -H "api_access_token: $INTERLEADS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "source_id": "+5511999998888",
    "inbox_id": 5,
    "contact_id": 456,
    "status": "open",
    "message": { "content": "Olá! Recebemos o seu contato." }
  }'

A resposta traz o id da conversa (conversation_id). O campo opcional message já dispara a primeira mensagem — se você omitir, use o passo 5.

5. Envie uma mensagem

bash
curl -X POST "https://appchat01.interleads.chat/api/v1/accounts/3/conversations/123/messages" \
  -H "api_access_token: $INTERLEADS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "Obrigado pelo contato! Em que posso ajudar?",
    "message_type": "outgoing"
  }'

Pronto — a mensagem sai pelo canal do inbox.

E agora?

  • Envie anexos, notas internas e liste o histórico → Mensagens
  • Atribua agentes, mude status e aplique labels → Conversas
  • Programe envios (follow-up, lembretes) → Mensagens agendadas
  • Empurre a oportunidade para o funil → Kanban

Documentação da API — Interleads Chat.