Para usar a telefonia VoIPstudio no Mavibot, você precisa criar uma chave de API na sua conta VoIPstudio, inseri-la nas configurações de integração e configurar a entrega de eventos para a URL que o Mavibot exibe após a integração ser conectada.

VoIPstudio é um PABX em nuvem com números de telefone disponíveis em mais de 70 países. Diferente de uma operadora de telecomunicações tradicional, ele suporta usuários internos, grupos de toque, filas e menus de URA, enquanto o bot opera em cima desse PABX.

O bot pode iniciar chamadas para clientes em nome dos funcionários, transferir e encerrar chamadas, salvar gravações e enviar eventos de chamada para a conversa.

Obtendo as Informações Necessárias

  1. Registre-se em voipstudio.com e compre um número de telefone no país desejado.
  2. Crie usuários no PABX — um para cada funcionário que receberá chamadas. As chamadas são entregues a todos os dispositivos registrados para um usuário, então você não precisa especificar um número de telefone separado para cada funcionário.
  3. Vá para Configurações → API, crie uma Chave de API e copie-a.

Conectando a Integração

Nas configurações de telefonia, selecione VoIPstudio e insira:

  • Chave de API — a chave da sua conta VoIPstudio.

A integração agora está conectada. Para desconectá-la, limpe o campo Chave de API e salve as configurações.

Após salvar, uma URL de notificação aparecerá na página. Copie-a:

https://chatter.mavibot.ai/voipstudio_webhook/

Não publique esta URL nem a compartilhe com ninguém. Se você desconectar e reconectar a integração, a chave permanece a mesma, então não precisará configurar as notificações novamente.

Em seguida, na sua conta VoIPstudio, vá para Integrações → Webhooks → Ativar → Adicionar Webhook, cole a URL copiada e selecione os seguintes eventos:

  • Mudança de Estado da Chamada — ou selecione Chamada Tocando, Chamada Conectada, Chamada Encerrada e Chamada Perdida individualmente;
  • Gravação de Chamada Pronta — se você precisar de gravações de chamadas.

Sem essa configuração, as chamadas de saída ainda funcionarão, mas os eventos de chamada não aparecerão na conversa.

Funcionários

Nas configurações do funcionário, preencha o campo ID do Usuário VoIPstudio — o identificador numérico do usuário no seu PABX, por exemplo 10002.

Insira o ID do usuário do PABX, não um número de telefone. Você pode encontrar o ID na lista de usuários da sua conta VoIPstudio. Sem ele, o botão de chamada no cartão do cliente não funcionará para esse funcionário.

Ligando a partir do Cartão do Cliente

Um botão de chamada aparecerá ao lado do número de telefone do cliente no cartão da conversa.

O VoIPstudio primeiro liga para o funcionário em todos os seus dispositivos registrados simultaneamente. Quando o funcionário atende, o VoIPstudio liga para o cliente e conecta as duas partes.

Se o funcionário não atender, o cliente não será chamado.

Funções da Calculadora

Chamada Funcionário para Cliente

voipstudio_employee_call(client_phone, employee_user_id, caller_id)

Parâmetros:

  • client_phone — o número de telefone do cliente. Obrigatório.
  • employee_user_id — o ID do usuário VoIPstudio do funcionário que deve receber a primeira chamada. Obrigatório.
  • caller_id — o número de telefone exibido para o cliente. Opcional. Você pode passar anonymous para ocultar o identificador de chamada.

Transferir uma Chamada

voipstudio_transfer_call(phone, call_id)

Transfere uma chamada ativa para outro número de telefone.

Parâmetros:

  • phone — o número de telefone para o qual a chamada deve ser transferida. Obrigatório e deve ser o primeiro parâmetro.
  • call_id — o identificador da chamada. Opcional. Se omitido, a chamada atual do cliente é obtida da variável voipstudio_call_id.

Encerrar uma Chamada

voipstudio_hangup_call(call_id)

Encerra uma chamada ativa.

Parâmetros:

  • call_id — o identificador da chamada. Opcional. Se omitido, a chamada atual do cliente é usada.

voipstudio_get_record_link(call_id)

Retorna um link para a gravação da chamada. O link normalmente é salvo automaticamente quando o evento de gravação pronta é recebido. Esta função é útil se esse evento não foi recebido.

Parâmetros:

  • call_id — o identificador da chamada. Opcional. Se omitido, a chamada atual do cliente é usada.

A função pesquisa as 100 gravações mais recentes na conta. Para uma chamada mais antiga em um PABX de alto volume, ela pode não encontrar a gravação. Nesse caso, recupere a gravação diretamente da sua conta VoIPstudio.

Callbacks Durante uma Chamada

Conforme a chamada progride, callbacks são enviados para a conversa no seguinte formato:

voipstudio_call_event call.hangup

O nome do evento é passado exatamente como recebido do VoIPstudio, por exemplo call.ringing, call.connected, call.hangup e outros. Os eventos disponíveis dependem de quais eventos você selecionou ao configurar as notificações.

Se nenhum nome de evento for fornecido, o estado da chamada é usado em vez disso:

INITIAL, RINGING, CONNECTED, ON_HOLD, HANGUP.

Um callback separado é enviado quando a gravação está pronta:

voipstudio_call_event recording

Aguarde o callback recording antes de usar o link de gravação. A gravação é processada após a chamada terminar, então a variável voipstudio_record_link ainda está vazia quando call.hangup é recebido.

Se dois funcionários dentro do seu próprio PABX estão falando entre si, os callbacks não são enviados para a conversa e nenhum cartão de cliente é criado.

Variáveis do Cliente Após uma Chamada

Variável Valor
voipstudio_call_id ID da chamada no VoIPstudio
voipstudio_call_state Estado da chamada: INITIAL, RINGING, CONNECTED, ON_HOLD, HANGUP
voipstudio_call_duration Duração da chamada em segundos
voipstudio_call_cause Motivo do encerramento da chamada
voipstudio_terminated_by Quem encerrou a chamada: caller ou callee
voipstudio_record_link Link para a gravação da chamada
voipstudio_record_id ID da gravação no VoIPstudio

Gravações de Chamadas

A gravação de chamadas é habilitada nas configurações do VoIPstudio e é gerenciada pelo próprio PABX. Se você precisar de gravações, habilite a gravação de chamadas na sua conta VoIPstudio e selecione o evento Gravação de Chamada Pronta ao configurar as notificações.

A URL voipstudio_record_link é protegida por uma chave de acesso. Ela não pode ser aberta diretamente em um navegador ou compartilhada com um cliente. Você pode baixar a gravação da sua conta VoIPstudio na seção de histórico de chamadas.

A gravação de chamadas está sujeita às leis aplicáveis. Na Alemanha, França, Espanha e na maioria dos estados dos EUA, o consentimento de ambas as partes pode ser necessário, e em algumas jurisdições um aviso falado no início da chamada também pode ser necessário. O proprietário da conta VoIPstudio é responsável por cumprir esses requisitos.

Solução de Problemas

Erro Causa
Erro de autorização ao criar uma chamada A Chave de API está incorreta ou expirada. Certifique-se de que a chave foi criada em Configurações → API em vez de obtida através de uma solicitação login.
As chamadas funcionam, mas nenhum callback aparece na conversa Nenhum webhook foi criado no VoIPstudio, o botão Ativar está desligado ou a URL errada foi inserida. Copie a URL inteira da página de integração, incluindo a chave no final.
A chamada não pode ser criada ou os dispositivos do funcionário não tocam Um número de telefone foi inserido em vez do ID do Usuário VoIPstudio, ou o usuário não tem dispositivos registrados.
O callback recording não é recebido A gravação de chamadas não está habilitada no VoIPstudio, ou o evento Gravação de Chamada Pronta não foi selecionado.

O VoIPstudio é cobrado diretamente pelo VoIPstudio: há uma taxa de assinatura para cada usuário do PABX, além dos custos de chamadas. Isso difere de operadoras que cobram por minuto sem assinatura recorrente. Ao estimar custos, leve em consideração o número de usuários configurados, não apenas o volume de chamadas.