Documentação Oficial REST API v2.0

Integre Telefonia WhatsApp & IA ao seu Software

Dispare chamadas de voz e vídeo em 38ms, receba eventos instantâneos por Webhooks e utilize inteligência artificial para transcrever e analisar conversas diretamente do seu CRM, n8n ou sistema próprio.

Base URL:https://api.argosvoip.com.br/api/v1
Auth: Bearer <ag_live_...>
Ver /llms.txt
POST
/api/v1/calls/audio
Voz WhatsApp
Header: Authorization: Bearer <chave>

Disparar Chamada de Voz

Dispara uma chamada telefônica de voz em tempo real para o WhatsApp do número informado.

Parâmetros da Requisição

CampoTipoObrigatórioDescrição
tostringSimNúmero com DDI e DDD (ex: '5511999998888')
contact_namestringOpcionalNome do lead para identificação
webhook_urlstringOpcionalURL para receber notificações desta chamada
Exemplo de Código (CURL)
curl -X POST "https://api.argosvoip.com.br/api/v1/calls/audio" \
  -H "Authorization: Bearer ag_live_9f8a42c6b9d04e7f9a12bc503e91a0c7" \
  -H "Content-Type: application/json" \
  -d '{"to":"5511999998888","contact_name":"Mariana Silva"}'
Resposta da API (200 OK)
{
  "success": true,
  "call_id": "ag_call_1788900000000",
  "status": "ringing",
  "type": "audio",
  "target": "5511999998888",
  "contact_name": "Mariana Silva",
  "engine_dispatched": true,
  "created_at": "2026-09-08T20:45:00.000Z"
}
POST
/api/v1/calls/video
Vídeo WhatsApp
Header: Authorization: Bearer <chave>

Disparar Chamada de Vídeo HD

Inicia uma videochamada direta com o cliente via stream H.264 nativo no WhatsApp.

Parâmetros da Requisição

CampoTipoObrigatórioDescrição
tostringSimNúmero de telefone com DDI e DDD
contact_namestringOpcionalNome do contato para a chamada
Exemplo de Código (CURL)
curl -X POST "https://api.argosvoip.com.br/api/v1/calls/video" \
  -H "Authorization: Bearer ag_live_9f8a42c6b9d04e7f9a12bc503e91a0c7" \
  -H "Content-Type: application/json" \
  -d '{"to":"5511999998888","contact_name":"Cliente VIP"}'
Resposta da API (200 OK)
{
  "success": true,
  "call_id": "ag_video_1788900000000",
  "status": "ringing",
  "type": "video",
  "target": "5511999998888",
  "created_at": "2026-09-08T20:45:00.000Z"
}
POST
/api/v1/calls/:id/hangup
Controle
Header: Authorization: Bearer <chave>

Encerrar Chamada Ativa

Desliga imediatamente uma ligação em andamento identificada pelo seu ID.

Parâmetros da Requisição

CampoTipoObrigatórioDescrição
:idstring (path)SimID da chamada retornado no disparo
Exemplo de Código (CURL)
curl -X POST "https://api.argosvoip.com.br/api/v1/calls/:id/hangup" \
  -H "Authorization: Bearer ag_live_9f8a42c6b9d04e7f9a12bc503e91a0c7" \
  -H "Content-Type: application/json" \
  -d 'null'
Resposta da API (200 OK)
{
  "success": true,
  "call_id": "ag_call_1788900000000",
  "status": "completed",
  "action": "hangup",
  "ended_at": "2026-09-08T20:47:30.000Z"
}
GET
/api/v1/calls/:id
Consulta
Header: Authorization: Bearer <chave>

Consultar Status da Chamada

Retorna o estado atual da ligação: ringing, in_progress, completed, busy ou missed.

Exemplo de Código (CURL)
curl -X GET "https://api.argosvoip.com.br/api/v1/calls/:id" \
  -H "Authorization: Bearer ag_live_9f8a42c6b9d04e7f9a12bc503e91a0c7" \
  -H "Content-Type: application/json"
Resposta da API (200 OK)
{
  "id": "ag_call_1788900000000",
  "contact_name": "Mariana Silva",
  "whatsapp_id": "5511999998888",
  "call_type": "audio",
  "direction": "efetuada",
  "status": "completed",
  "duration_sec": 154,
  "recorded": true,
  "started_at": "2026-09-08T20:45:00.000Z",
  "ended_at": "2026-09-08T20:47:34.000Z"
}
GET
/api/v1/instances
Infraestrutura
Header: Authorization: Bearer <chave>

Status das Instâncias WhatsApp

Verifica a conectividade e a disponibilidade dos chips WhatsApp pareados para chamadas.

Exemplo de Código (CURL)
curl -X GET "https://api.argosvoip.com.br/api/v1/instances" \
  -H "Authorization: Bearer ag_live_9f8a42c6b9d04e7f9a12bc503e91a0c7" \
  -H "Content-Type: application/json"
Resposta da API (200 OK)
{
  "engine": {
    "status": "online",
    "protocol": "WhatsApp VoIP"
  },
  "instances": [
    {
      "id": "dev-01",
      "name": "WhatsApp Atendimento",
      "phone_number": "5511999990001",
      "status": "connected",
      "battery_level": 98
    }
  ]
}
POST
/api/v1/ai/analyze
IA Semântica
Header: Authorization: Bearer <chave>

Análise de Sentimento & Resumo por IA

Processa o diálogo da conversa e extrai classificação de sentimento (-1.0 a +1.0), previsão de satisfação, resumo executivo e próximos passos.

Parâmetros da Requisição

CampoTipoObrigatórioDescrição
textstringOpcionalTexto da transcrição a ser analisado (*obrigatório se não passar call_id)
call_idstringOpcionalID da chamada para puxar gravação gravada
recording_idstringOpcionalID do arquivo de áudio gravado
Exemplo de Código (CURL)
curl -X POST "https://api.argosvoip.com.br/api/v1/ai/analyze" \
  -H "Authorization: Bearer ag_live_9f8a42c6b9d04e7f9a12bc503e91a0c7" \
  -H "Content-Type: application/json" \
  -d '{"text":"Olá, gostaria de saber o valor do plano Pro e como integrar chamadas com o n8n."}'
Resposta da API (200 OK)
{
  "success": true,
  "sentiment": "positive",
  "sentiment_score": 0.85,
  "urgency": "medium",
  "customer_satisfaction_prediction": "alta (92%)",
  "summary": "Chamada comercial onde o lead demonstrou interesse em integrar ligações de WhatsApp ao seu fluxo no n8n, solicitando proposta do plano Pro.",
  "key_topics": [
    "Telefonia WhatsApp",
    "API REST",
    "Integração n8n",
    "Plano Pro"
  ],
  "action_items": [
    "Enviar proposta comercial do Plano Pro",
    "Compartilhar documentação técnica de Webhooks",
    "Agendar follow-up em até 24 horas"
  ],
  "model": "Argos-LLM-Insight-v2",
  "created_at": "2026-09-08T20:48:00.000Z"
}
POST
/api/v1/ai/transcribe
Whisper Turbo
Header: Authorization: Bearer <chave>

Transcrição Automática Whisper v3

Transcreve gravações de áudio com identificação de idioma, pontuação, timestamps e diarização de atendente e cliente.

Parâmetros da Requisição

CampoTipoObrigatórioDescrição
call_idstringOpcionalID da chamada no sistema
audio_urlstringOpcionalURL pública ou interna do áudio a transcrever
Exemplo de Código (CURL)
curl -X POST "https://api.argosvoip.com.br/api/v1/ai/transcribe" \
  -H "Authorization: Bearer ag_live_9f8a42c6b9d04e7f9a12bc503e91a0c7" \
  -H "Content-Type: application/json" \
  -d '{"call_id":"ag_call_1788900000000"}'
Resposta da API (200 OK)
{
  "success": true,
  "language": "pt-BR",
  "confidence": 0.98,
  "duration_sec": 45,
  "transcription": "Olá, tudo bem? Aqui é o cliente. Gostaria de confirmar nossa reunião e entender as integrações com a API de telefonia do Argos Voip.",
  "segments": [
    {
      "start": 0,
      "end": 4.2,
      "text": "Olá, tudo bem? Aqui é o cliente.",
      "speaker": "speaker_1"
    },
    {
      "start": 4.5,
      "end": 12,
      "text": "Gostaria de tirar dúvidas sobre o discador VoIP e integração via API.",
      "speaker": "speaker_2"
    }
  ],
  "model": "Argos-Whisper-v3-Turbo",
  "created_at": "2026-09-08T20:48:00.000Z"
}
GET
/api/v1/recordings
Gravações
Header: Authorization: Bearer <chave>

Listar Gravações & Mídias

Retorna o histórico de gravações de voz e vídeo com links diretos de áudio e metadados de inteligência artificial.

Exemplo de Código (CURL)
curl -X GET "https://api.argosvoip.com.br/api/v1/recordings" \
  -H "Authorization: Bearer ag_live_9f8a42c6b9d04e7f9a12bc503e91a0c7" \
  -H "Content-Type: application/json"
Resposta da API (200 OK)
{
  "total": 1,
  "recordings": [
    {
      "id": "rec_1788900000000",
      "call_id": "ag_call_1788900000000",
      "contact_name": "Mariana Silva",
      "whatsapp_id": "5511999998888",
      "media_type": "audio",
      "duration_sec": 154,
      "file_url": "https://api.argosvoip.com.br/recordings/audio_01.wav",
      "transcription": "Olá, tudo bem? Aqui é o cliente...",
      "sentiment": "positive"
    }
  ]
}
Módulo de Inteligência Artificial v2.1

IA para Telefonia WhatsApp: Whisper v3, Sentimento & Agentes Autônomos

Conecte agentes LLM (OpenAI, Claude, LangChain, n8n) ao WhatsApp com suporte a chamadas ativas, transcrição automática em alta fidelidade e auditoria semântica em tempo real.

Como Usar Tokens de Autenticação em Agentes de IA

Header Bearer Token
Obrigatório

Todas as chamadas exigem o cabeçalho HTTP:

Authorization: Bearer ag_live_...

Use ag_live_... para produção e ag_test_... para simulação sem custo.

Variáveis de Ambiente
Segurança

Nunca exponha sua chave no prompt visível para o usuário final. Configure na tool calling:

ARGOS_API_KEY = os.getenv(...)

O LLM apenas invoca o nome da tool; o código de backend injeta a chave de forma segura.

Rate Limits & Quotas
Performance

120 requisições/min com capacidade de pico de até 300 requisições/min.

Isolamento multi-tenant garantido: cada token é estritamente vinculado à sua organização no banco.

Esquema de Ferramentas (Tool Calling / Function Calling)

Copie e cole o schema abaixo diretamente na definição de tools do seu agente inteligente:

[
  {
    "type": "function",
    "function": {
      "name": "argos_start_voice_call",
      "description": "Dispara uma chamada telefônica de voz via WhatsApp para um cliente ou lead pelo Argos Voip.",
      "parameters": {
        "type": "object",
        "properties": {
          "to": { "type": "string", "description": "Número com DDI e DDD (ex: 5511999998888)" },
          "contact_name": { "type": "string", "description": "Nome do contato para identificar" }
        },
        "required": ["to"]
      }
    }
  },
  {
    "type": "function",
    "function": {
      "name": "argos_analyze_call",
      "description": "Analisa sentimento (-1.0 a +1.0), resumo e objeções de uma ligação gravada.",
      "parameters": {
        "type": "object",
        "properties": {
          "call_id": { "type": "string", "description": "ID da chamada no sistema" },
          "text": { "type": "string", "description": "Texto a ser analisado" }
        }
      }
    }
  }
]

Casos de Uso com IA Prontos para Produção

SDR de Vendas com Ligação Imediata

Quando um lead preenche seu formulário, o agente LLM decide ligar no mesmo minuto via WhatsApp. Ao atender, transfere para um atendente com contexto ou executa uma URA conversacional com IA.

Auditoria Automática & QA de Chamadas

100% das chamadas gravadas passam pelo Whisper v3 Turbo e pela análise de sentimento. Leads insatisfeitos disparam alerta urgente no Slack e CRM com o resumo das objeções.

Webhooks Instantâneos

Notificações de Eventos em Tempo Real

O Argos Voip envia requisições HTTP POST para o seu servidor ou ferramenta No-Code (n8n/Typebot) com assinatura criptográfica HMAC SHA-256 no header X-ArgosVoip-Signature.

Cadastrar Webhook
call.startedPOST JSON

Disparado no momento em que o WhatsApp do contato começa a tocar.

{
  "event": "call.started",
  "timestamp": "2026-09-08T20:45:01.000Z",
  "organization_id": "org_corporate_01",
  "data": {
    "call_id": "ag_call_1788900000000",
    "contact_name": "Mariana Silva",
    "whatsapp_id": "5511999998888",
    "call_type": "audio",
    "direction": "efetuada",
    "status": "ringing"
  }
}
call.answeredPOST JSON

Disparado quando o cliente aceita a chamada no WhatsApp.

{
  "event": "call.answered",
  "timestamp": "2026-09-08T20:45:07.000Z",
  "organization_id": "org_corporate_01",
  "data": {
    "call_id": "ag_call_1788900000000",
    "status": "in_progress",
    "answered_at": "2026-09-08T20:45:07.000Z"
  }
}
call.endedPOST JSON

Disparado ao término da chamada com a duração exata em segundos.

{
  "event": "call.ended",
  "timestamp": "2026-09-08T20:47:34.000Z",
  "organization_id": "org_corporate_01",
  "data": {
    "call_id": "ag_call_1788900000000",
    "status": "completed",
    "duration_sec": 147,
    "ended_at": "2026-09-08T20:47:34.000Z"
  }
}
recording.availablePOST JSON

Disparado quando o áudio/vídeo da chamada e a transcrição inicial estiverem prontos.

{
  "event": "recording.available",
  "timestamp": "2026-09-08T20:47:40.000Z",
  "organization_id": "org_corporate_01",
  "data": {
    "call_id": "ag_call_1788900000000",
    "recording_id": "rec_1788900000000",
    "file_url": "https://api.argosvoip.com.br/recordings/audio_01.wav",
    "duration_sec": 147,
    "transcription": "Olá, gostaria de saber o valor do plano Pro...",
    "sentiment": "positive"
  }
}
ai.analysis_readyPOST JSON

Disparado com a análise semântica completa por IA (resumo, tags e sentiment score).

{
  "event": "ai.analysis_ready",
  "timestamp": "2026-09-08T20:47:45.000Z",
  "organization_id": "org_corporate_01",
  "data": {
    "call_id": "ag_call_1788900000000",
    "sentiment": "positive",
    "sentiment_score": 0.85,
    "summary": "Cliente solicitou informações sobre contratação do plano Pro para equipe de vendas.",
    "key_topics": [
      "Telefonia WhatsApp",
      "API REST",
      "n8n"
    ]
  }
}

Plug & Play com suas Ferramentas Favoritas

Dispare ligações automáticas ao receber um novo lead no formulário ou fechar uma venda.

n8n Workflow
No-Code

Adicione um nó HTTP Request com método POST, aponte para a URL de áudio e insira seu Bearer token.

Typebot
Chatbot

Dispare uma chamada quando o usuário pedir para falar com atendente ou terminar um formulário.

HubSpot CRM
CRM

Grave chamadas e envie o link do áudio e resumo por IA para o histórico do contato no CRM.

RD Station
Automação

Acione ligações automáticas de follow-up a cada lead qualificado que entrar na base.

7 Dias de Teste Grátis

Pronto para Começar a Integrar?

Crie seu workspace corporativo em 2 minutos, conecte seu chip WhatsApp pelo QR Code e receba sua chave de API ativa instantaneamente.