Voltar ao siteCallface
Public Integration API

Integre sua aplicação à Callface

Registre sua aplicação, receba insights de chamadas via webhook e ofereça uma experiência integrada aos seus usuários.

Como funciona

1

Registre sua app

Envie uma requisição POST com os dados da sua aplicação.

2

Homologação

Realizamos testes para garantir que a integração é funcional e segura.

3

Produção

Sua app é aprovada e disponibilizada para todos os clientes Callface.

Registrar aplicação

POSThttps://api.dev.callface.io/integrate-app/register

Envie uma requisição POST com o corpo JSON abaixo para registrar sua aplicação no ambiente de homologação.

{
  "name": "Nome do seu app",
  "description": "Descrição do seu app",
  "webhook_url": "https://seu.dominio/receber-insights",
  "needed_credentials": ["credencial_a", "credencial_b"],
  "register_token": "seu_token_de_registro"
}

Parâmetros

namestring

Nome da sua aplicação.

descriptionstring

Breve descrição da sua aplicação.

webhook_urlstring

URL onde você receberá os insights das chamadas.

needed_credentialsstring[]

Lista de campos que sua aplicação espera receber para validar e identificar o usuário (vendedor) antes de processar os insights da chamada.

register_tokenstring

Token de registro enviado previamente por e-mail.

Resposta de sucesso

{
  "message": "APP_REGISTERED_AND_READY_FOR_TESTS"
}

Recebendo dados via Webhook

Quando uma organização conectada à sua aplicação encerrar uma chamada na Callface, seu app receberá automaticamente os insights e dados da ligação na URL configurada em webhook_url.

{
  "deal_id": "id-do-lance",
  "contact_id": "id-do-contato",
  "summarization": "Resumo e insights da ligação",
  "user_email": "vendedor@empresa.com",
  "user_name": "Nome do vendedor",
  "destination_number": "+5511999999999",
  "call_audio_url": "https://storage.callface.ai/audio.mp3",
  "call_link": "https://app.callface.ai/chamada/abc123",
  "call_date": "2025-05-20T14:40:56.441Z",
  "call_duration": 14,
  "credentials": [
    {
      "name": "client_id",
      "value": "client_xxxx"
    }
  ]
}

Campos do payload

deal_idstring

Identificador do lance/negócio.

contact_idstring

Identificador do contato.

summarizationstring

Resumo e insights da ligação gerados pela IA.

user_emailstring

E-mail do usuário responsável pela ligação.

user_namestring

Nome do usuário responsável pela ligação.

destination_numberstring

Número de telefone do cliente.

call_audio_urlstring

URL do áudio da chamada.

call_linkstring

Link para os detalhes da chamada na Callface.

call_dateISO 8601

Data e horário da chamada.

call_durationnumber

Duração da chamada em segundos.

credentialsobject[]

Credenciais do usuário configuradas na integração. Cada item contém name e value.

Autenticação

O register_token é enviado por e-mail pela equipe da Callface. Se você ainda não tem um token, entre em contato conosco para solicitar acesso ao programa de integrações.

Pronto para integrar?

Solicite seu token de registro e comece a construir sua integração com a Callface hoje mesmo.

Solicitar token

Dúvidas sobre a integração? Fale com a gente