phoneWebphone

Introdução

Essa biblioteca foi feita com o intuito de facilitar a realização de ligações por dispositivos da Wavoip. Ela disponibiliza uma interface customizável e isolada do projeto onde está instalada. Esse webphone usa o wavoip-api (Websocket) por debaixo dos panos

Instalação

Instale a biblioteca utilizando seu gerenciador de dependências favorito

pnpm add @wavoip/wavoip-webphone

Primeiros Passos

Biblioteca instalada

Importe o objeto do webphone e chame a função render()

import WavoipWebphone from "@wavoip/wavoip-webphone"

WavoipWebphone.render()

Simples assim, a interface será renderizada na tela.

Para remover a interface, basta chamar a função destroy()

WavoipWebphone.destroy()

CDN

Use a variável wavoipWebphone que se encontra dentro da variável window

Controlando o Webphone em Código (API)

Ao renderizar o webphone, ele retornára uma Promisearrow-up-right de uma API para controlá-lo, além de criar uma propriedade wavoip na variável windowarrow-up-right com a mesma API

A partir disso, você pode utilizar a API da forma que escolher:

circle-exclamation

WebphoneAPI

Controlando as Chamadas (CallAPI)

Para informações sobre como iniciar uma call leia: Realizando uma ligação (Outgoing)

  • setInput(): Seta o input de número para ligar na interface do webphone

Controlando os Dispositivos (DeviceAPI)

Para informações sobre os dispositivos, leia Dispositivos

Ao adicionar um dispositivo com addDevice passando o parâmetro persist como True o dispositivo e suas configurações serão salvas no Local Storagearrow-up-right do navegador, persistindo entre sessões

circle-info

Desabilitar um dispositivo mata a conexão entre o webphone e o dispositivo, mas o dispositivo continua rodando

Controlando as Notificações (NotificationsAPI)

Controlando o Widget (WidgetAPI)

Controlando o Tema (ThemeAPI)

Controlando a Posição (PositionAPI)

Configurando o Webphone

Inicialização

Ao renderizar o webphone com o render() você pode passar alguns parâmetros

Os parâmetros são os seguintes

Enquanto roda (SettingsAPI)

Ao renderizar, a variável window terá uma propriedade wavoip que pode ser usada para mudar as configurações em tempo real

Atualizado