Integrador Webhook - Chamada de Campanha - Fim de Chamada com Contato

Owned by Iuri Diniz (Unlicensed)
Last updated: Sept 26, 2023 by Lucas Castro
5 min read

Disponível a partir da versão 7.29.0

Esse recurso oferece a possibilidade de integrar o Evolux à outras plataformas, permitindo o envio de informações de quando um assinante foi feito um contato com sucesso

Para acessa-lo, basta ir em APLICATIVOS > MARKETPLACE, selecione a opção do Integrador Webhook Genérico

O ambiente de Marketplace vem desabilitado por padrão, para ter acesso ao mesmo, favor contactar o Suporte Evolux.

Quando esse webhook é chamado

Existe apenas um momento para isso acontecer na versão 7.29.0 que é quando a chamada termina. Somente chamadas que foram conectados a um operador disparam esse evento.

Note que não há um garantia forte de que o WebHook vai ser chamada exatamente quando a chamada termina, pode demorar alguns segundos ou até mesmo minutos, principalmente em horas de alta demanda de ligações.

Em cado de dúvidas, entre em contato com o suporte para obter mais informações.

Crie e Configure seu Webhook

 

  1. Escolha o evento que vc quer acompanhar: campaign_call::connected

  2. Selecione o método HTTP: POST , GET, PUT, DELETE

  3. Insira a URL que vai ser chamada.

  4. Insira os dados que serão postados nesta URL

    1. Veja tabela a seguir para saber as possível variáveis

    2. Seguem dados usados nesse teste:

      { "uuid da chamada": "{{call.uuid}}", "uuid da gravacao": "{{call.recording_uuid}}", "inicio da chamada": "{{call.start_time}}", "inicio da chamada (iso8601)": "{{call.start_time_iso8601}}", "atendimento do chamada": "{{call.answer_time}}", "atendimento do chamada (iso8601)": "{{call.answer_time_iso8601}}", "fim da chamada": "{{call.end_time}}", "fim da chamada (iso8601)": "{{call.end_time_iso8601}}", "classificacao da chamada": "{{call.classification}}", "resultado da chamada": "{{call.outcome}}", "causa de encerramento da chamada": "{{call.hangup_cause}}", "quem desligou a chamada": "{{call.hangup_by}}", "numero chamado": "{{call.number}}", "tronco usado": "{{call.trunk}}", "id do assinante no evolux": "{{subscriber.id}}", "id do assinante externo": "{{subscriber.external_id}}", "nome do assinante": "{{subscriber.name}}", "campos personalizados - CPF": "{{subscriber.custom_fields['cpf']}}", "estado do assinante": "{{subscriber.status}}", "id da campanha no evolux": "{{campaign.id}}", "nome da campanha": "{{campaign.name}}", "id do operador no evolux": "{{agent.id}}", "nome do operador": "{{agent.name}}", "login do operador": "{{agent.login}}", "email do operador": "{{agent.email}}" }

  5. Clique em Criar

Exemplo de uma chamada POSTpara o webhook criado acima

POST /callme HTTP/1.1 Host: ex.com Accept-Encoding: gzip, deflate Accept: */* Connection: keep-alive Content-Type: application/json { "uuid da chamada":"378d43fe-9d1b-4ef3-a4b2-b9d7d22ec5b3", "uuid da gravacao":"378d43fe-9d1b-4ef3-a4b2-b9d7d22ec5b3", "inicio da chamada":"20/09/2023 11:24:10", "inicio da chamada (iso8601)":"2023-09-20T11:24:10-03:00", "atendimento do chamada":"20/09/2023 11:24:18", "atendimento do chamada (iso8601)":"2023-09-20T11:24:18-03:00", "fim da chamada":"20/09/2023 11:24:19", "fim da chamada (iso8601)":"2023-09-20T11:24:19-03:00", "classificacao da chamada":"subscriber_gave_up", "resultado da chamada":"", "causa de encerramento da chamada":"NORMAL_CLEARING", "quem desligou a chamada":"subscriber", "numero chamado":"1150004000", "tronco usado":"", "id do assinante no evolux":"39", "id do assinante externo":"", "nome do assinante":"Felipe", "campos personalizados - CPF":"", "estado do assinante":"Completed", "id da campanha no evolux":"1", "nome da campanha":"campanha de teste", "id do operador no evolux":"1", "nome do operador":"Genivaldo", "login do operador":"genis", "email do operador":"", }

Variáveis

O corpo de request é totalmente personalizável, para usar uma variável utilize {{nome da variável}}

 

As possíveis variáveis para serem utilizadas são:

Nome

Descrição

Exemplos de valores

Nome

Descrição

Exemplos de valores

{{call.id}}

ID dessa chamada.

Esse ID pode ser usado para acessar a API de chamadas de campanha. Veja: https://evolux.atlassian.net/l/cp/vgtXwoYh

"1001"

{{call.uuid}}

UUID dessa chamada.

"378d43fe-9d1b-4ef3-a4b2-b9d7d22ec5b3"

{{call.recording_uuid}}

UUID dessa chamada para fins de gravação.

Esse UUID pode ser usado para obter a gravação via (usando o navegador web):

https://NOME-DO-SEU-EVOLUX/download_recording_uuid/{{call.recording_uuid}}

ou via (usando um API TOKEN):

https://NOME-DO-SEU-EVOLUX/api/v1/recording/{{call.recording_uuid}}

Veja:

"378d43fe-9d1b-4ef3-a4b2-b9d7d22ec5b3"

{{call.start_time}}

Horário de início da chamada respeitando a configuração do evolux (língua e fuso horário).

Em português, teria o formato: DD/MM/AAAA HH:MM:SS

Em inglês, teria o formato: MM/DD/AAAA HH:MM:SS

"20/09/2023 11:24:18"

"09/23/2023 11:24:18"

{{call.start_time_iso8601}}

Horário de início da chamada respeitando o formato ISO8601. Precisão de segundos.

"2023-09-20T11:24:10-03:00"

"2023-09-20T12:39:18+00:00"

{{call.answer_time}}

Horário de atendimento da chamada respeitando a configuração do evolux (língua e fuso horário).

Em português, teria o formato: DD/MM/AAAA HH:MM:SS

Em inglês, teria o formato: MM/DD/AAAA HH:MM:SS

"20/09/2023 11:24:18"

{{call.answer_time_iso8601}}

Horário de atendimento da chamada respeitando o formato ISO8601. Precisão de segundos.

"2023-09-20T11:24:18-03:00"

{{call.end_time}}

Horário de fim da chamada respeitando a configuração do evolux (língua e fuso horário).

Em português, teria o formato: DD/MM/AAAA HH:MM:SS

Em inglês, teria o formato: MM/DD/AAAA HH:MM:SS

"20/09/2023 11:24:19"

{{call.end_time_iso8601}}

Horário de fim da chamada respeitando o formato ISO8601. Precisão de segundos.

"2023-09-20T11:24:19-03:00"

{{call.talking_duration}}

Duração da chamada, tempo em segundos desde o tempo de atendimento até o tempo fim. Ou seja:

{{call.talking_duration}} = {{call.end_time}} - {{call.answer_time}}

"10"

{{call.classification}}

Classificação da chamada. Pode vir vazio.

Ver Possíveis Classificações mais abaixo.

Para campaign_call::connected deve vir na maioria das vezes ou vazio ou "subscriber_gave_up".

"voice_mail"

"amd_voice_mail"

"invalid_number"

"no_route_match"

"reschedule"

"do_not_call"

"subscriber_gave_up"

"call_dropped"

{{call.formatted_classification}}

Classificação da chamada de forma humanizada respeitando a língua atualmente configurada. Pode vir vazio.

Para campaign_call::connected deve vir na maioria das vezes ou vazio ou "Subscriber Gave Up", se inglês, e "Assinante Desligou", se em português.

"Chamada Caiu"

"Call Dropped"

"Assinante Desligou"

"Subscriber Gave Up"

{{call.outcome}}

Conclusão/Motivação da chamada. Pode vir vazio. Ver .

"Comprou o produto"

{{call.hangup_cause}}

Causa do desligamento da chamada.

Para campaign_call::connecteddeve ser sempre "NORMAL_CLEARING".

"NORMAL_CLEARING"

{{call.formatted_hangup_cause}}

Causa do desligamento da chamada de forma humanizada respeitando a língua atualmente configurada.

Para campaign_call::connecteddeve ser sempre "Normal clearing", se inglês, e "Desligamento normal", se em português.

"Normal clearing"

"Desligamento normal"

{{call.hangup_by}}

Indica quem desligou a chamada. Sendo subscriber quando o assinante desligou e sendo agent quando o operador desligou.

"subscriber"

"agent"

{{call.number}}

Número discado nessa chamada.

"1150004000"

{{call.trunk}}

Nome do tronco usando nessa chamada.

"Conta SIP na TELECOM"

{{subscriber.id}}

ID do assinante no Evolux.

"1"

{{subscriber.external_id}}

ID externo cadastrado para este assinante.

"9999"

"ext123"

{{subscriber.name}}

Nome do assinante.

"Elis Regina"

{{subscriber.numbers[INTEIRO]}}

 

Array de todos o números do assinante. Deve ser acessado pelo índice do elemento.

Acessando o número na posição 0: {{subscriber.number[0]}}.

"8499991234"

{{subscriber.status}}

Estado do assinante, para campaign_call::connecteddeve ser sempre "Completed".

"Completed"

{{subscriber.custom_fields['NOME_DO_CAMPO']}}

 

Array associativo dos campos customizados cadastrados para esse assinante.

Deve ser acessado pelo índice do elemento.

Acessando o campo customizado de nome cpf: {{subscriber.custom_fields['cpf']}}

"12312312399"

{{agent.id}}

ID do operador no Evolux.

"10"

{{agent.name}}

Nome do operador

"Gabriel Barbosa"

{{agent.login}}

Login (nome do usuário) do operador.

"gabigol"

{{agent.email}}

email do operador.

"gabigol@nacao.com.br"

{{campaign.name}}

Nome da campanha.

"Venda de Senhas"

{{campaign.id}}

ID da campanha no Evolux.

"1"

Possíveis Classificações

Classification

Descrição

Classification

Descrição

voice_mail

Caixa postal - Detecção manual.

amd_voice_mail

Caixa postal - Detecção automática.

invalid_number

Número inválido.

no_route_match

Sem rota para o número fornecido.

reschedule

Reagendar.

do_not_call

Não ligar.

subscriber_gave_up

O assinante desligou da chamada.

call_dropped

A chamada caiu.