Notificações de chamada

• Descrição: Dê a esta notificação um nome que reconheça facilmente. Só a sua equipa o vê, nunca quem liga.
• Serviço: Escolha para onde vai esta notificação: selecione Personalizado para configurar manualmente, ou Robin para enviar diretamente para a integração Robin.
• URL do webhook: Cole o URL completo do webhook, incluindo https://, para onde quer que estas notificações sejam enviadas.

• Call notifications_send_summary_events: Se ativar esta opção, os resumos das chamadas serão incluídos nas notificações de chamada. Atenção: o Intelligence tem de estar ativo para que isto funcione.
• Call notifications_send_transcription_events: Se ativar esta opção, as transcrições das chamadas serão incluídas nas notificações de chamada. Atenção: o Intelligence tem de estar ativo para que isto funcione.

Durante uma chamada, a informação é enviada para o URL especificado em seis momentos diferentes para chamadas recebidas, internas e efetuadas: Criada, A tocar, Atendida, Transferência com apresentação, Transferência direta e Pendurar. As notificações são enviadas para o URL especificado em vários eventos importantes durante uma chamada. As notificações são enviadas como um pedido POST com os dados num documento JSON. Abaixo, pode ver que informação é enviada exatamente.

Criada

Um evento created é acionado quando uma chamada recebida é iniciada.

• call_id: Uma string única para identificar a chamada.
• timestamp: A data e hora em que o webhook é gerado, no formato ISO 8601.
• status: O estado da chamada. Para este tipo de notificação, é created.
• version: Um atributo de versão que pode ser usado no futuro para migrar para outra versão dos webhooks. Atualmente, é sempre v2.
• direction: Se uma chamada é recebida (inbound) ou efetuada (outbound). O evento created é enviado apenas para chamadas recebidas.
• caller: Informação sobre quem está a ligar.
• number: O número de telefone que a pessoa está a usar.
• name: O nome de quem está a ligar.
• account_number: Esta informação não é enviada com o evento created.
• user_numbers: Esta informação não é enviada com o evento created.
• user_emails: Esta informação não é enviada com o evento created.
• destination: Informação sobre para onde a chamada é direcionada.
• number: O número de telefone que a pessoa marcou.

A tocar

Uma notificação ringing é enviada quando os telefones começam a tocar devido a uma chamada recebida.

É possível que várias notificações ringing sejam enviadas em sequência à medida que novos dispositivos começam a tocar.

• call_id: Uma string única para identificar a chamada.
• timestamp: A data e hora em que o webhook é gerado, no formato ISO 8601.
• status: O estado da chamada. Para este tipo de notificação, é ringing.
• version: Um atributo de versão que pode ser usado no futuro para migrar para outra versão dos webhooks. Atualmente, é sempre v2.
• direction: Se uma chamada é recebida (inbound) ou efetuada (outbound). Chamadas entre colegas são marcadas como outbound.
• caller: Informação sobre quem está a ligar.
• number: O número de telefone que a pessoa está a usar.
• name: O nome de quem está a ligar.
• account_number: Esta informação não é enviada com o evento ringing.
• user_numbers: Esta informação não é enviada com o evento ringing.
• user_emails: Esta informação não é enviada com o evento ringing.
• destination: Informação sobre para onde a chamada é direcionada.
• number: O número de telefone que a pessoa marcou.
• targets: Os telefones que estão a tocar para esta chamada. Telefones que não estão alcançáveis não são mostrados.
• number: O número que está a ser chamado. Normalmente é o mesmo que destination.number, mas pode mudar se a chamada for desviada.
• name: O nome da pessoa que está a ser chamada. Para chamadas recebidas, é quase sempre null.
• account_number: Os números internos dos utilizadores que configuraram a sua Conta VoIP para estar acessíveis (quando disponível, pode ser um array vazio).
• user_numbers: Os números internos dos utilizadores que estão acessíveis (quando disponível, pode ser um array vazio).
• user_emails: Os endereços de email dos utilizadores.

Atendida (em curso)

É enviada uma notificação in-progress quando uma chamada é atendida.

Nota! O target que atende a chamada nem sempre é um dos dispositivos que tocaram inicialmente. Devido à resposta de chamadas, pode acontecer que a chamada seja atendida num dispositivo diferente.

• call_id: Uma sequência única para identificar a chamada.
• timestamp: A data e hora em que o webhook é gerado, em formato ISO 8601.
• status: O estado da chamada. Para este tipo de notificação, é in-progress.
• version: Um atributo de versão que pode ser utilizado no futuro para migrar para outra versão dos webhooks. Atualmente, é sempre v2.
• direction: Se a chamada é recebida (inbound) ou efetuada (outbound). Chamadas entre colegas são marcadas como outbound.
• caller: Informação sobre quem está a ligar.
• number: O número de telefone que a pessoa está a utilizar.
• name: O nome de quem está a ligar.
• account_number: O número interno da Conta VoIP (quando disponível, para chamadas recebidas é quase sempre null).
• user_numbers: Os números internos dos utilizadores que estão contactáveis (quando disponível, pode ser um array vazio).
• user_emails: Os endereços de email dos utilizadores.
• destination: Informação sobre o destino da chamada.
• number: O número de telefone que foi marcado.
• targets: Os telefones que estão a tocar para esta chamada. Telefones que estão inacessíveis não são apresentados.
• number: O número que está a ser chamado. Normalmente é o mesmo que destination.number, mas pode mudar se a chamada for desviada.
• name: O nome da pessoa que está a ser chamada. Para chamadas recebidas, é quase sempre null.
• account_number: Os números internos dos utilizadores que configuraram a sua Conta VoIP para estar contactável (quando disponível, pode ser um array vazio).
• user_numbers: Os números internos dos utilizadores que estão contactáveis (quando disponível, pode ser um array vazio).
• user_emails: Os endereços de email dos utilizadores.

Transferência assistida

É enviada uma notificação warm-transfer quando uma chamada é transferida de forma "assistida". Numa transferência assistida, quem transfere primeiro liga para o novo participante, o novo participante atende, fala com quem transfere, e depois a chamada é transferida.

A chamada de quem transfere para terceiros também gera notificações ringing e in-progress com o seu próprio call_id. Durante uma transferência, estas duas chamadas são essencialmente fundidas numa única chamada. O call_id de uma das duas chamadas é então utilizado para a chamada após a transferência. O outro call_id é incluído na transferência como merged_id e é depois descartado.

• call_id: Uma sequência única para identificar a chamada, transferida de uma das chamadas anteriores.
• merged_id: O call_id da outra chamada anterior, que deixará de ser utilizado.
• timestamp: A data e hora em que o webhook é gerado, em formato ISO 8601.
• status: O estado da chamada. Para este tipo de notificação, é transfer.
• version: Um atributo de versão que pode ser utilizado no futuro para migrar para outra versão dos webhooks. Atualmente, é sempre v2.
• direction: Se a chamada é recebida (inbound) ou efetuada (outbound). Chamadas entre colegas são marcadas como outbound.
• caller: Informação sobre quem está a ligar.
• number: O número de telefone que a pessoa está a utilizar.
• name: O nome de quem está a ligar.
• account_number: O número interno da Conta VoIP (quando disponível, para chamadas recebidas é quase sempre null).
• user_numbers: Os números internos dos utilizadores que estão contactáveis (quando disponível, pode ser um array vazio).
• user_emails: Os endereços de email dos utilizadores.
• destination: Informação sobre o destino da chamada.
• number: O número de telefone que foi marcado.
• targets: Os telefones que estão a tocar para esta chamada. Telefones que estão inacessíveis não são apresentados.
• number: O número que está a ser chamado. Normalmente é o mesmo que destination.number, mas pode mudar se a chamada for desviada.
• name: O nome da pessoa que está a ser chamada. Para chamadas recebidas, é quase sempre null.
• account_number: Os números internos dos utilizadores que configuraram a sua Conta VoIP para estar contactável (quando disponível, pode ser um array vazio).
• user_numbers: Os números internos dos utilizadores que estão contactáveis (quando disponível, pode ser um array vazio).
• user_emails: Os endereços de email dos utilizadores.
• redirector: Informação sobre o participante que realizou a transferência.
• number: O número de telefone que está a ser utilizado por quem transfere.
• name: O nome de quem transfere.
• account_number: O número interno da Conta VoIP (quando disponível, para chamadas recebidas é quase sempre null).
• user_numbers: Os números internos dos utilizadores que estão contactáveis (quando disponível, pode ser um array vazio).
• user_emails: Os endereços de e-mail dos utilizadores.

Transferência fria

Uma notificação cold-transfer é enviada quando uma chamada é transferida a frio. Numa transferência fria, quem transfere liga para o novo participante mas transfere a chamada sem esperar para ver se alguém atende ou quem atende.

Existem duas diferenças principais entre uma cold-transfer e uma warm-transfer:

• Numa transferência quente, há sempre uma parte chamada, enquanto numa transferência fria pode haver várias (por exemplo, se a chamada for transferida para um grupo de chamadas).
• Para uma transferência quente, são geradas primeiro notificações ringing e in-progress. Numa transferência fria, apenas é enviada uma notificação ringing, e uma notificação in-progress segue-se apenas se a terceira parte atender a chamada.

A chamada de quem transfere para a terceira parte também gera uma notificação ringing com o seu próprio call_id. Durante uma transferência, estas duas chamadas são essencialmente fundidas numa única chamada. O call_id de uma das duas chamadas é então utilizado para a chamada após a transferência. O outro call_id é incluído na transferência como merged_id e é depois descartado.

• call_id: Uma string única para identificar a chamada, mantida de uma das chamadas anteriores.
• merged_id: O call_id da outra chamada anterior, que deixará de ser utilizado.
• timestamp: A data e hora em que o webhook é gerado, em formato ISO 8601.
• status: O estado da chamada. Para este tipo de notificação, é transfer.
• version: Um atributo de versão que pode ser utilizado no futuro para migrar para outra versão dos webhooks. Atualmente, é sempre v2.
• direction: Se uma chamada é recebida ou efetuada. Atualmente, apenas chamadas recebidas são suportadas, pelo que este valor é sempre inbound.
• caller: Informação sobre quem liga.
• number: O número de telefone que quem liga está a utilizar.
• name: O nome de quem liga.
• account_number: O número interno da Conta VoIP (quando disponível, para chamadas recebidas é quase sempre null).
• user_numbers: Os números internos dos utilizadores que estão acessíveis (quando disponível, pode ser um array vazio).
• user_emails: Os endereços de e-mail dos utilizadores.
• destination: Informação sobre para onde a chamada é direcionada.
• number: O número de telefone que quem liga marcou.
• targets: Os telefones que estão a tocar para esta chamada. Telefones que estão inacessíveis não são mostrados.
• number: O número a ser chamado. Geralmente é o mesmo que destination.number, mas pode mudar se a chamada for desviada.
• name: O nome da pessoa que está a ser chamada. Para chamadas recebidas, é quase sempre null.
• account_number: Os números internos dos utilizadores que configuraram a sua Conta VoIP para estar acessível (quando disponível, pode ser um array vazio).
• user_numbers: Os números internos dos utilizadores que estão acessíveis (quando disponível, pode ser um array vazio).
• user_emails: Os endereços de e-mail dos utilizadores.
• redirector: Informação sobre o participante que realizou a transferência.
• number: O número de telefone que quem redireciona está a utilizar.
• name: O nome de quem redireciona.
• account_number: O número interno da Conta VoIP (quando disponível, para chamadas recebidas é quase sempre null).
• user_numbers: Os números internos dos utilizadores que estão acessíveis (quando disponível, pode ser um array vazio).
• user_emails: Os endereços de e-mail dos utilizadores.

Desligar (terminada)

Uma notificação ended é enviada quando uma chamada é terminada. Existem várias razões pelas quais uma chamada pode terminar.

Uma notificação ended pode ser enviada após uma notificação in-progress se a chamada foi desligada por um dos participantes, após uma notificação ringing se ninguém atendeu, ou como única notificação se nenhum dispositivo estava acessível.

• call_id: Uma string única para identificar a chamada.
• timestamp: A data e hora em que o webhook é gerado, em formato ISO 8601.
• status: O estado da chamada. Para este tipo de notificação, é ended.
• reason: A razão pela qual a chamada terminou. A razão pode ser um dos seguintes valores:
1. completed: A chamada foi concluída com sucesso.
2. busy: A chamada foi rejeitada, quem recebe estava ocupado.
3. no-answer: Ninguém atendeu a chamada por várias razões.
4. failed: Ocorreu um erro que impediu o estabelecimento da chamada.
5. cancelled: Quem liga desligou antes de alguém poder atender.
6. abandon: Quem liga desligou enquanto aguardava na fila.
• version: Um atributo de versão que pode ser utilizado no futuro para migrar para outra versão dos webhooks. Atualmente, é sempre v2.
• direction: Se uma chamada é recebida (inbound) ou efetuada (outbound). Chamadas entre colegas são marcadas como outbound.
• caller: Informação sobre quem liga.
• number: O número de telefone que quem liga está a utilizar.
• name: O nome de quem está a ligar.
• account_number: O número interno da Conta VoIP (quando disponível; para chamadas recebidas, é quase sempre null).
• user_numbers: Os números internos dos utilizadores que estão disponíveis (quando disponível; pode ser um array vazio).
• user_emails: Os endereços de email dos utilizadores.
• destination: Informação sobre para onde a chamada é dirigida.
• number: O número de telefone marcado por quem está a ligar.

Transcrição criada

Uma notificação call_transcription é enviada quando a transcrição estiver pronta.

Se o Voys Intelligence estiver ativado. Este é o primeiro evento que se seguirá a uma notificação ended. Se os resumos de chamadas estiverem ativados, o evento summary seguir-se-á em breve.

{            
  "call_id": "ua0-grq-prd-1780997460.58680",
  "call_transcription": "Speaker 1: Hi how are you.\nSpeaker 2: Hey great that you called.",        
}

Resumo criado

Uma notificação summary é enviada quando o resumo da chamada estiver pronto.

Se o Voys Intelligence estiver ativado. Este é o último evento para uma chamada específica.

{
  "call_id": "ua0-grq-prd-1780997460.58680", 
  "summary": "This was a great call."
}

Gravação de chamada criada

Um evento call recording created é enviado assim que a gravação de uma chamada estiver disponível.

O conteúdo do evento é o seguinte:

{
"call_id": "ua0-grq-prd-1741083170.160935",
"recording_url": "https://api.voys.nl/api/v2/clients/9f515223-c139-4704-a031-57342c8809a4/callrecordings/ua0-grq-prd-1741083170.160935/audio"
}

Pode usar recording_url diretamente para obter a gravação com a sua chave de API. Não é necessário construir o URL ou procurar o ID do cliente.

São enviadas várias notificações para cada chamada. As notificações enviadas dependem de como a chamada é processada. Abaixo está a ordem de notificações para os tipos de chamadas mais comuns.

Chamada simples

Uma chamada bem-sucedida com dois participantes:

• ringing - A liga para B
• in-progress - A liga para B
• ended - A liga para B (motivo: completed)

Chamada simples com Voys Intelligence ativado

Uma chamada bem-sucedida com dois participantes:

• ringing - A liga para B
• in-progress - A liga para B
• ended - A liga para B (motivo: completed)
• call_transcription - a transcrição da chamada está pronta
• summary - o resumo da chamada está pronto

Sem resposta

O telefone de quem recebe toca mas não é atendido.

• ringing - A liga para B
• ended - A liga para B (motivo: busy ou no-answer dependendo do dispositivo)

Destinatário indisponível

Quem recebe está indisponível (por exemplo, o telefone está em Não Incomodar), por isso o telefone não toca e a chamada não é atendida.

• ended - A liga para B (motivo: busy)

Transferência Assistida

Numa transferência assistida (transferência calorosa), A liga primeiro para B, depois um dos participantes transfere a chamada para C. O participante liga primeiro para C e, depois de falarem, a chamada é transferida. Apenas os participantes A e C permanecem na chamada.

• ringing - A liga para B
• in-progress - A liga para B
• ringing - B liga para C
• in-progress - B liga para C
• warm-transfer - B liga A e C
• ended - A e C desligam (motivo: completed)
• call_transcription - a transcrição da chamada está pronta (uma por segmento de chamada, se ativado)
• summary - o resumo da chamada está pronto (um por segmento de chamada, se ativado)

Transferência Cega

Numa transferência cega (transferência fria), A liga primeiro para B, depois um dos participantes transfere a chamada para C sem esperar para ver se C está disponível.

• ringing - A liga para B
• em curso - A liga para B
• a tocar - B liga para C
• transferência direta - B conecta A e C
• em curso - A liga para C
• terminada - A já não está em chamada com C (motivo: completed)
• call_transcription - transcrição da chamada está pronta
• summary - resumo da chamada está pronto

Transferência semi-assistida

Numa transferência semi-assistida (transferência morna), A liga primeiro para B e, em seguida, um dos participantes transfere a chamada para C. O participante tenta ligar para C primeiro, mas transfere a chamada antes de C atender.

• a tocar - A liga para B
• em curso - A liga para B
• a tocar - B liga para C
• transferência direta - B conecta A e C
• em curso - A liga para C
• terminada - A já não está em chamada com C (motivo: completed)
• call_transcription - transcrição da chamada está pronta
• summary - resumo da chamada está pronto

Resposta de Chamada

Quando dois telefones estão no mesmo grupo de resposta, é possível atender uma chamada destinada a outro telefone a partir de um telefone.

• a tocar - A liga para B
• em curso - A liga para C
• terminada - A já não está em chamada com C (motivo: completed)
• call_transcription - transcrição da chamada está pronta
• summary - resumo da chamada está pronto

Desvio de chamada

Quando um utilizador configura o seu telefone para reencaminhar automaticamente chamadas recebidas para outro número.

• a tocar - A liga para B
• a tocar - A liga para B e C
• em curso ou terminada, dependendo se alguém atende.
• call_transcription - transcrição da chamada está pronta
• summary - resumo da chamada está pronto

• Aceda a Notificações de Chamada.
• Clique em Adicionar.
• Introduza uma descrição no campo Descrição para especificar o objetivo da notificação.
• Escolha 'Personalizado' nas opções de Pacote, a menos que prefira usar uma opção padrão.
• Preencha o URL para onde as notificações de conversação devem ser enviadas.
• Preencha o Token API se o pacote selecionado fornecer um.

Nota: isto só é necessário se o pacote emitir um token API.

• Clique em Guardar.

Abaixo encontram-se alguns exemplos de integrações em combinação com o Zapier:

• Enviar uma mensagem para o Slack para uma chamada perdida.
• Enviar um email para uma chamada perdida.
• Integração Robin.
• Integração Microsoft Flow
• Integração Zapier

E um exemplo com N8N e a nossa API de transcrição de chamadas

n8n: registar gravações, transcrições e resumos de chamadas