💻 API Interfala

Construa em cima da Interfala.
Em minutos.

API REST moderna, webhooks em tempo real e documentação completa. Conecte WhatsApp, Instagram e Telegram ao seu sistema com poucas linhas de código.

Ler documentação Criar conta gratuita

REST + JSON Webhooks real-time 99.9% uptime Suporte BR

POST /v1/messages 200 OK

// Enviar mensagem via WhatsApp
const response = await fetch('https://api.interfala.com.br/v1/messages', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    to: '5511999999999',
    channel: 'whatsapp',
    type: 'text',
    text: 'Olá! Seu pedido foi confirmado 🎉'
  })
});

const data = await response.json();
console.log(data.message_id);

🚀 Quick Start

Em produção em 3 passos

Do zero ao primeiro envio em menos de 5 minutos.

Obtenha sua API Key

Crie sua conta na Interfala e acesse o painel de desenvolvedor para gerar uma API Key.

curl -H "Authorization: Bearer YOUR_API_KEY"

Acessar painel

Conecte um canal

Vincule WhatsApp, Instagram ou Telegram à sua conta. A Interfala cuida da autenticação e tokens das APIs oficiais.

WhatsApp Instagram Telegram

Ver guia de conexão

Envie a primeira mensagem

Uma única chamada POST e sua mensagem chega no destinatário em segundos.

POST /v1/messages

Ver documentação completa

📖 Exemplos

Use a linguagem que você já conhece

Exemplos prontos pra copiar e colar — em qualquer linguagem.

send-message.js JavaScript

import { Interfala } from 'interfala-sdk';

const interfala = new Interfala({
  apiKey: process.env.INTERFALA_API_KEY
});

const message = await interfala.messages.send({
  to: '5511999999999',
  channel: 'whatsapp',
  type: 'image',
  image: {
    url: 'https://exemplo.com/imagem.jpg',
    caption: 'Confira nossa promoção 🎉'
  }
});

console.log(`Mensagem enviada: ${message.id}`);

send-message.php PHP

<?php
$client = new Interfala\Client('YOUR_API_KEY');

$message = $client->messages->send([
    'to'      => '5511999999999',
    'channel' => 'whatsapp',
    'type'    => 'image',
    'image'   => [
        'url'     => 'https://exemplo.com/imagem.jpg',
        'caption' => 'Confira nossa promoção 🎉'
    ]
]);

echo "Mensagem enviada: " . $message->id;

send_message.py Python

from interfala import Interfala

client = Interfala(api_key="YOUR_API_KEY")

message = client.messages.send(
    to="5511999999999",
    channel="whatsapp",
    type="image",
    image={
        "url": "https://exemplo.com/imagem.jpg",
        "caption": "Confira nossa promoção 🎉"
    }
)

print(f"Mensagem enviada: {message.id}")

terminal cURL

curl -X POST https://api.interfala.com.br/v1/messages \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "5511999999999",
    "channel": "whatsapp",
    "type": "image",
    "image": {
      "url": "https://exemplo.com/imagem.jpg",
      "caption": "Confira nossa promoção"
    }
  }'

send_message.rb Ruby

require 'interfala'

client = Interfala::Client.new(api_key: 'YOUR_API_KEY')

message = client.messages.send(
  to:      '5511999999999',
  channel: 'whatsapp',
  type:    'image',
  image: {
    url:     'https://exemplo.com/imagem.jpg',
    caption: 'Confira nossa promoção 🎉'
  }
)

puts "Mensagem enviada: #{message.id}"

⚡ SDKs oficiais em desenvolvimento. Por enquanto, use a API REST diretamente — totalmente padronizada e documentada.

🔌 Recursos

Tudo que você precisa para construir

Uma API completa para integrar comunicação no seu sistema.

Mensagens

Envie e receba mensagens em WhatsApp, Instagram, Telegram, Messenger e Email.

POST /v1/messages

GET /v1/messages/:id

GET /v1/conversations

Ver documentação

Contatos

Gerencie sua base de contatos, etiquetas, campos customizados e histórico.

POST /v1/contacts

GET /v1/contacts/:id

PATCH /v1/contacts/:id

Ver documentação

Webhooks

Receba eventos em tempo real: novas mensagens, mudanças de status e atendimentos.

POST /v1/webhooks

EVENT message.received

EVENT conversation.assigned

Ver documentação

Chatbots e Fluxos

Crie e gerencie fluxos de automação programaticamente, sem sair do seu stack.

POST /v1/flows

POST /v1/flows/:id/trigger

GET /v1/flows

Ver documentação

Atendentes e Setores

Distribuição inteligente de conversas, gerenciamento de equipe e filas.

GET /v1/agents

POST /v1/conversations/:id/assign

GET /v1/sectors

Ver documentação

Relatórios

Acesse métricas, estatísticas de atendimento e dados de performance.

GET /v1/reports/conversations

GET /v1/reports/agents

GET /v1/reports/channels

Ver documentação

⚡ Real-time

Webhooks que avisam na hora

Em vez de ficar consultando nossa API, deixe a Interfala te avisar quando algo importante acontece. Webhooks em tempo real com retry automático e logs auditáveis.

Nova mensagem recebida message.received
Mensagem enviada com sucesso message.sent
Conversa atribuída a atendente conversation.assigned
Atendimento finalizado conversation.closed

Documentação de webhooks

Webhook payload message.received

POST https://seusite.com/webhook
Content-Type: application/json
X-Interfala-Signature: sha256=...

{
  "event": "message.received",
  "timestamp": "2025-01-15T10:30:00Z",
  "data": {
    "message_id": "msg_abc123",
    "conversation_id": "conv_xyz789",
    "from": "5511999999999",
    "channel": "whatsapp",
    "type": "text",
    "text": "Quero saber mais sobre o produto",
    "contact": {
      "name": "Maria Silva",
      "phone": "5511999999999"
    }
  }
}

💡 Casos de uso

O que você pode construir

Integrações que clientes da Interfala estão fazendo hoje.

🛒

Notificações de e-commerce

Envie atualizações de pedido (confirmado, enviado, entregue) direto no WhatsApp do cliente. Integra com Shopify, WooCommerce, Nuvemshop.

webhooks whatsapp e-commerce

🔗

Sincronização com CRM

Quando uma nova conversa começa, crie automaticamente um lead no seu CRM (HubSpot, RD Station, Salesforce). Quando o lead é convertido, atualize o status.

webhooks crm contacts

🤖