Notificações de chamada

O que são as Notificações de chamada?

O módulo de Notificações de Chamada permite enviar automaticamente dados de chamadas para um URL à sua escolha. Estas notificações de chamada são enviadas para o URL especificado para todas as chamadas no seu portal.

Ao integrar estas notificações de chamada com o seu software de CRM, pode ver quem ligou, a hora da chamada e a sua duração.

As notificações de chamada são acionadas para chamadas recebidas, internas e efetuadas. Pode também usar as notificações de chamada para outros fins, como medir estatísticas de chamadas.

Não deixe de consultar Webhooks para maximizar as capacidades do seu serviço telefónico.

‣

Os acionadores de notificação de chamada

Durante uma chamada, a informação é enviada para o URL especificado em seis momentos diferentes para chamadas recebidas, internas e efetuadas: Criada, A tocar, Respondida, Transferência acompanhada, 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 ler exatamente que informação é enviada.

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, em formato ISO 8601.
status: O estado da chamada. Para este tipo de notificação, é created.
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). O evento criado é enviado apenas para chamadas recebidas.
caller: Informação sobre quem está a ligar.

number: O número de telefone que está a ser utilizado por quem liga.
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 o destino da chamada.

number: O número de telefone que foi marcado.

A tocar

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

É possível que sejam enviadas várias notificações ringing sucessivamente à 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, em formato ISO 8601.
status: O estado da chamada. Para este tipo de notificação, é ringing.
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 está a ligar.

number: O número de telefone que está a ser utilizado por quem liga.
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 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 inacessí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, isto é quase sempre null.
account_number: Os números internos dos utilizadores que configuraram a sua Conta VoIP para estarem 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.

Respondida (em curso)

Uma notificação in-progress é enviada quando uma chamada é respondida.

Nota! O target que responde à chamada nem sempre é um dos dispositivos que inicialmente tocou. Devido à resposta de chamada, pode acontecer que a chamada seja respondida num dispositivo diferente.

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, é 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 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 quem está a ligar está a usar.
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 podem ser contactados (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 é direcionada.

number: O número de telefone que quem está a ligar marcou.
targets: Os telefones que estão a tocar para esta chamada. Telefones que não estão acessíveis não são mostrados.

number: O número a ser chamado. Normalmente é o mesmo que destination.number, mas pode mudar se a chamada for desviada.
name: O nome da pessoa a ser chamada. Para chamadas recebidas, é quase sempre null.
account_number: Os números internos dos utilizadores que configuraram a sua Conta VoIP para poderem ser contactados (quando disponível, pode ser um array vazio).
user_numbers: Os números internos dos utilizadores que podem ser contactados (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 o terceiro 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 usado para a chamada após a transferência. O outro call_id é incluído na transferência como merged_id e é então 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 (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 quem está a ligar está a usar.
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 podem ser contactados (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 é direcionada.

number: O número de telefone que quem está a ligar marcou.
targets: Os telefones que estão a tocar para esta chamada. Telefones que não estão acessíveis não são mostrados.

number: O número a ser chamado. Normalmente é o mesmo que destination.number, mas pode mudar se a chamada for desviada.
name: O nome da pessoa a ser chamada. Para chamadas recebidas, é quase sempre null.
account_number: Os números internos dos utilizadores que configuraram a sua Conta VoIP para poderem ser contactados (quando disponível, pode ser um array vazio).
user_numbers: Os números internos dos utilizadores que podem ser contactados (quando disponível, pode ser um array vazio).
user_emails: Os endereços de email dos utilizadores.

redirector: Informação sobre o participante que efetuou a transferência.

number: O número de telefone que quem redireciona está a usar.
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 podem ser contactados (quando disponível, pode ser um array vazio).
user_emails: Os endereços de email dos utilizadores.

Transferência direta

É enviada uma notificação cold-transfer quando uma chamada é transferida de forma direta. Numa transferência direta, 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 assistida, existe sempre um destinatário, enquanto numa transferência direta podem existir vários (por exemplo, se a chamada for transferida para um Grupo de chamadas).
Para uma transferência assistida, são geradas primeiro notificações ringing e in-progress. Numa transferência direta, apenas é enviada uma notificação ringing, e uma notificação in-progress só é enviada se o terceiro atender a chamada.

A chamada do transferidor para o terceiro também gera uma notificação ringing com o seu próprio call_id. Durante uma transferência, estas duas chamadas são essencialmente unidas 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, 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 uma chamada é recebida ou efetuada. Atualmente, apenas chamadas recebidas são suportadas, pelo que este valor é sempre inbound.
caller: Informação sobre quem está a ligar.

number: O número de telefone que quem está a ligar 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 isto é 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 email dos utilizadores.

destination: Informação sobre para onde a chamada é direcionada.

number: O número de telefone que quem está a ligar 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. Normalmente é o mesmo que destination.number, mas pode mudar se a chamada for desviada.
name: O nome da pessoa a ser chamada. Para chamadas recebidas, isto é 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 email dos utilizadores.

redirector: Informação sobre o participante que efetuou a transferência.

number: O número de telefone que o redirecionador está a utilizar.
name: O nome do redirecionador.
account_number: O número interno da Conta VoIP (quando disponível, para chamadas recebidas isto é 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 email dos utilizadores.

Pendurar (ended)

Uma notificação ended é enviada quando uma chamada termina. 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 for pendida por um dos participantes, após uma notificação ringing se ninguém atender, ou como a única notificação se nenhum dispositivo estiver 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:

completed: The call was successfully completed.
busy: The call was rejected, the callee was busy.
no-answer: No one answered the call for various reasons.
failed: An error occurred preventing the call from being established.
cancelled: The caller hung up before anyone could answer.
abandon: The caller hung up while waiting in the queue.

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 está a ligar.

number: O número de telefone que quem está a ligar 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 isto é 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 email dos utilizadores.

destination: Informação sobre para onde a chamada é direcionada.

number: O número de telefone que quem está a ligar marcou.

‣

Ordem das notificações

São enviadas várias notificações para cada chamada. As notificações enviadas dependem da forma como a chamada é tratada. Abaixo está a ordem das 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)

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

O destinatário está indisponível (por exemplo, o telefone está definido como 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 acompanhada), A liga primeiro para B e depois um dos participantes transfere a chamada para C. O participante liga primeiro para C e, após terem falado, 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 conecta A e C
ended - A e C desligam (motivo: completed)

Transferência direta

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

ringing - A liga para B
in-progress - A liga para B
ringing - B liga para C
cold-transfer - B conecta A e C
in-progress - A liga para C
ended - A já não liga para C (motivo: completed)

Transferência semi-assistida

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

ringing - A liga para B
in-progress - A liga para B
ringing - B liga para C
cold-transfer - B conecta A e C
in-progress - A liga para C
ended - A já não liga para C (motivo: completed)

Resposta de chamada

Quando dois telefones estão no mesmo grupo de resposta, é possível atender numa estação uma chamada destinada a outra.

ringing - A liga para B
in-progress - A liga para C
ended - A já não liga para C (motivo: completed)

Desvio de chamada

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

ringing - A liga para B
ringing - A liga para B e C
in-progress ou ended, dependendo se alguém atende.

‣

Configurar Notificações de chamada

‣

Exemplos de integrações

Perguntas Frequentes

‣

Qual é a diferença entre notificações de chamada e webhooks?

‣

Para que chamadas podem ser utilizadas as notificações de chamada?

‣

Que formato de dados é enviado?

‣

Que método de pedido HTTP devo utilizar?

Páginas relacionadas

Voys Intelligence

Obter automaticamente transcrições de chamadas usando N8N

Estatísticas

Estatísticas da Fila

Webhooks

Notificações de chamada

O que são as Notificações de chamada?

Ao integrar estas notificações de chamada com o seu software de CRM, pode ver quem ligou, a hora da chamada e a sua duração.

As notificações de chamada são acionadas para chamadas recebidas, internas e efetuadas. Pode também usar as notificações de chamada para outros fins, como medir estatísticas de chamadas.

Não deixe de consultar Webhooks para maximizar as capacidades do seu serviço telefónico.

‣

Os acionadores de notificação de chamada

Criada

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

{
  "call_id": "ua9-grq-prd-1693575683.22973164",
  "timestamp": "2023-09-01T13:41:25.972110+00:00",
  "status": "created",
  "version": "v2",
  "direction": "inbound",
  "caller": {
    "number": "+31507009920",
    "name": "Johan",
    "account_number": null,
    "user_numbers": [],
    "user_emails": []
  },
  "destination": {
    "number": "+31332022074"
  }
}

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, é created.
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). O evento criado é enviado apenas para chamadas recebidas.
caller: Informação sobre quem está a ligar.

number: O número de telefone que está a ser utilizado por quem liga.
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 o destino da chamada.

number: O número de telefone que foi marcado.

A tocar

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

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

{
  "call_id": "ua9-grq-prd-1693575683.22973164",
  "timestamp": "2023-09-01T13:41:26.020742+00:00",
  "status": "ringing",
  "version": "v2",
  "direction": "inbound",
  "caller": {
    "number": "+31507009920",
    "name": "Johan",
    "account_number": null,
    "user_numbers": [],
    "user_emails": []
  },
  "destination": {
    "number": "+31332022074",
    "targets": [
      {
        "number": "+31332022074",
        "name": null,
        "account_number": "201",
        "user_numbers": [
          "610"
        ],
        "user_emails": [
          "email@email.com"
        ]
      }
    ]
  }
}

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, é ringing.
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 está a ligar.

number: O número de telefone que está a ser utilizado por quem liga.
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 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 inacessí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, isto é quase sempre null.
account_number: Os números internos dos utilizadores que configuraram a sua Conta VoIP para estarem 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.

Respondida (em curso)

Uma notificação in-progress é enviada quando uma chamada é respondida.

{
  "call_id": "ua9-grq-prd-1693575683.22973164",
  "timestamp": "2023-09-01T13:41:26.992074+00:00",
  "status": "in-progress",
  "version": "v2",
  "direction": "inbound",
  "caller": {
    "number": "+31507009920",
    "name": "Johan",
    "account_number": null,
    "user_numbers": [],
    "user_emails": []
  },
  "destination": {
    "number": "+31332022074",
    "target": {
      "number": "+31332022074",
      "name": null,
      "account_number": "201",
      "user_numbers": [
        "610"
      ],
      "user_emails": [
        "email@email.com"
      ]
    }
  }
}

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, é 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 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 quem está a ligar está a usar.
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 podem ser contactados (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 é direcionada.

number: O número de telefone que quem está a ligar marcou.
targets: Os telefones que estão a tocar para esta chamada. Telefones que não estão acessíveis não são mostrados.

number: O número a ser chamado. Normalmente é o mesmo que destination.number, mas pode mudar se a chamada for desviada.
name: O nome da pessoa a ser chamada. Para chamadas recebidas, é quase sempre null.
account_number: Os números internos dos utilizadores que configuraram a sua Conta VoIP para poderem ser contactados (quando disponível, pode ser um array vazio).
user_numbers: Os números internos dos utilizadores que podem ser contactados (quando disponível, pode ser um array vazio).
user_emails: Os endereços de email dos utilizadores.

Transferência assistida

{
  "call_id": "ua7-ams-prd-1693576700.23986757",
  "merged_id": "ua7-ams-prd-1693576711.23987220",
  "timestamp": "2023-09-01T13:58:44.399054+00:00",
  "status": "warm-transfer",
  "version": "v2",
  "direction": "inbound",
  "caller": {
    "number": "+31507009920",
    "name": "Johan N",
    "account_number": null,
    "user_numbers": [],
    "user_emails": []
  },
  "destination": {
    "number": "629",
    "target": {
      "number": "629",
      "name": null,
      "account_number": "203",
      "user_numbers": [
        "629"
      ],
      "user_emails": [
        "email2@email.com"
      ]
    }
  },
  "redirector": {
    "number": "610",
    "name": "Johan N",
    "account_number": "201",
    "user_numbers": [
      "610"
    ],
    "user_emails": [
      "email@email.com"
    ]
  }
}

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 (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 quem está a ligar está a usar.
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 podem ser contactados (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 é direcionada.

number: O número de telefone que quem está a ligar marcou.
targets: Os telefones que estão a tocar para esta chamada. Telefones que não estão acessíveis não são mostrados.

number: O número a ser chamado. Normalmente é o mesmo que destination.number, mas pode mudar se a chamada for desviada.
name: O nome da pessoa a ser chamada. Para chamadas recebidas, é quase sempre null.
account_number: Os números internos dos utilizadores que configuraram a sua Conta VoIP para poderem ser contactados (quando disponível, pode ser um array vazio).
user_numbers: Os números internos dos utilizadores que podem ser contactados (quando disponível, pode ser um array vazio).
user_emails: Os endereços de email dos utilizadores.

redirector: Informação sobre o participante que efetuou a transferência.

number: O número de telefone que quem redireciona está a usar.
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 podem ser contactados (quando disponível, pode ser um array vazio).
user_emails: Os endereços de email dos utilizadores.

Transferência direta

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

Numa transferência assistida, existe sempre um destinatário, enquanto numa transferência direta podem existir vários (por exemplo, se a chamada for transferida para um Grupo de chamadas).
Para uma transferência assistida, são geradas primeiro notificações ringing e in-progress. Numa transferência direta, apenas é enviada uma notificação ringing, e uma notificação in-progress só é enviada se o terceiro atender a chamada.

{
  "call_id": "ua4-grq-prd-1693576927.25584586",
  "merged_id": "ua4-grq-prd-1693576937.25585499",
  "timestamp": "2023-09-01T14:02:17.054643+00:00",
  "status": "cold-transfer",
  "version": "v2",
  "direction": "inbound",
  "caller": {
    "number": "+31507009920",
    "name": "Johan N",
    "account_number": null,
    "user_numbers": [],
    "user_emails": []
  },
  "destination": {
    "number": "629",
    "targets": [
      {
        "number": "629",
        "name": null,
        "account_number": "203",
        "user_numbers": [
          "629"
        ],
        "user_emails": [
          "email2@email.com"
        ]
      }
    ]
  },
  "redirector": {
    "number": "+31332022074",
    "name": null,
    "account_number": "201",
    "user_numbers": [
      "610"
    ],
    "user_emails": [
      "email@email.com"
    ]
  }
}

call_id: Uma string ú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 uma chamada é recebida ou efetuada. Atualmente, apenas chamadas recebidas são suportadas, pelo que este valor é sempre inbound.
caller: Informação sobre quem está a ligar.

number: O número de telefone que quem está a ligar 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 isto é 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 email dos utilizadores.

destination: Informação sobre para onde a chamada é direcionada.

number: O número de telefone que quem está a ligar 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. Normalmente é o mesmo que destination.number, mas pode mudar se a chamada for desviada.
name: O nome da pessoa a ser chamada. Para chamadas recebidas, isto é 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 email dos utilizadores.

redirector: Informação sobre o participante que efetuou a transferência.

number: O número de telefone que o redirecionador está a utilizar.
name: O nome do redirecionador.
account_number: O número interno da Conta VoIP (quando disponível, para chamadas recebidas isto é 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 email dos utilizadores.

Pendurar (ended)

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

{
  "call_id": "ua9-grq-prd-1693575683.22973164",
  "timestamp": "2023-09-01T13:41:27.653775+00:00",
  "status": "ended",
  "reason": "completed",
  "version": "v2",
  "direction": "inbound",
  "caller": {
    "number": "+31507009920",
    "name": "Johan",
    "account_number": null,
    "user_numbers": [],
    "user_emails": []
  },
  "destination": {
    "number": "+31332022074"
  }
}

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:

completed: The call was successfully completed.
busy: The call was rejected, the callee was busy.
no-answer: No one answered the call for various reasons.
failed: An error occurred preventing the call from being established.
cancelled: The caller hung up before anyone could answer.
abandon: The caller hung up while waiting in the queue.

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 está a ligar.

number: O número de telefone que quem está a ligar 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 isto é 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 email dos utilizadores.

destination: Informação sobre para onde a chamada é direcionada.

number: O número de telefone que quem está a ligar marcou.

‣

Ordem das notificações

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)

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

O destinatário está indisponível (por exemplo, o telefone está definido como 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

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 conecta A e C
ended - A e C desligam (motivo: completed)

Transferência direta

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