Ao receber chamadas (Áudio/Vídeo)

Sempre que receber ligações, seja com áudio ou vídeo enviaremos um evento neste Webhook.

IMPORTANTE: Não é possível atender ou fazer chamadas via API.

Header do request
Atributo Descrição Obrigatório Tipo

hook

Em todos os nossos Webhooks você irá receber este parâmetro no header do nosso request, cada tipo de Webhook irá enviar um valor diferente.

Para este Webhook você irá receber o valor: onIncomingCall

Sim

String

apiKey

Aqui você irá receber o MD5 da API Key do canal de atendimento/conta conectada em nossa plataforma, possibilitando que você confirme de qual canal se trata o Webhook.

Para identificar corretamente, pegue a API Key gerada na área de integrações do CRONCRM, gere md5(SUA_API_KEY) e compare com o valor recebido em apiKey.

IMPORTANTE: O header apiKey não é a API Key “pura”, e sim o seu MD5.

Sim

String

Body do request
Atributo Descrição Obrigatório Tipo

call_id

ID da chamada.

Sim

String

contact_wid

Número/identificador do contato.

Sim

String

started_on

Data e hora em que a chamada foi recebida.

Sim

DateTime

is_video

Se for uma chamada em vídeo, por padrão todas as chamadas são em áudio, então sempre que for em vídeo este parâmetro irá receber o valor de true.

Sim

Boolean

in_group

Se for uma chamada em grupo.

Sim

Boolean

automatic_alert

Se o rejeitar chamadas da plataforma estiver ativo.

Sim

Boolean

automatic_alert_text

Mensagem que será enviada se o rejeitar chamadas da plataforma estiver ativado.

Sim

String

{
  "call_id": "B64074B51EC4205033",
  "contact_wid": "[email protected]",
  "started_on": {
    "date": "2023-12-07 17:56:56",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "is_video": false,
  "in_group": false,
  "automatic_alert": false,
  "automatic_alert_text": ""
}