Skip to main content
As integrações do tipo HyperMeow (com ligações) fazem e recebem ligações de voz do WhatsApp. Pela API você pode deixar um sistema externo (um bot, uma URA) atender essas ligações, falar com o contato e, quando quiser, devolver a ligação para a fila de atendimento.

Como funciona

  1. Cadastre um webhook CALL_ROUTING na integração, pela rota Cadastrar Webhook com "type": "CALL_ROUTING", ou pelo painel em Integrações → Webhooks. Só pode existir um por integração.
  2. Com esse webhook cadastrado, as ligações recebidas não aparecem para os atendentes. Cada ligação dispara o webhook de ligações com os dados de quem está ligando.
  3. Sua aplicação atende (ou recusa) a ligação e conecta no WebSocket de áudio para ouvir e falar com o contato.
  4. Para passar a ligação para um atendente, use Transferir ligação para a fila. A ligação passa a tocar para os atendentes e o primeiro que atender fica com ela.
  5. Enquanto espera na fila, o contato ouve em loop o áudio de espera cadastrado no webhook (holdAudioUrl). Sem áudio cadastrado, o contato fica em silêncio.
Também é possível ligar para um número pela API: a ligação fica com a sua aplicação do mesmo jeito, e pode ser transferida para a fila.
Uma ligação na fila não tem tempo limite: ela espera até um atendente assumir, o contato desligar ou a API encerrar a ligação.

Estados da ligação

O campo answeredBy diz com quem a ligação está: api quando é da sua aplicação, o ID do atendente quando um atendente assumiu, ou null quando ninguém atendeu. queued é true depois que a API transferiu a ligação para a fila.

Áudio da ligação

O áudio é trocado por um WebSocket, aberto depois que a ligação foi atendida pela API (ou depois que o contato atendeu, numa ligação iniciada pela API):
A autenticação é a mesma das outras rotas: cabeçalho Authorization: Bearer <token>, ou o parâmetro ?token=<token> para clientes que não conseguem enviar cabeçalhos no WebSocket. As mensagens são binárias nos dois sentidos, em PCM 16 bits little-endian, mono, 16 kHz, em quadros de 960 amostras (60 ms, 1920 bytes):
  • o que você recebe é a voz do contato;
  • o que você envia é tocado para o contato.
O WebSocket é fechado (código 1000) quando a ligação termina ou é transferida para a fila. Abrir um segundo WebSocket para a mesma ligação substitui o primeiro.

Exemplo (Node.js)