Material de referência do SDK

Métodos globais do SDK

Init

Obtenha uma instância da API do discador e certifique-se de que a interface do discador esteja pronta (consulte Métodos de instância do discador do SDK)

Parâmetro Tipo Descrição
dialerConfig [objeto] Opções de configuração do discador.
callback [função] Função de retorno de chamada.

setProvider

Permite trocar o provedor (CC/UC) após a interface do discador ter sido carregada.

Parâmetros Tipo Descrição
provider "cc" / "uc"
  • O CC carrega o ContactPad do Call Center da Vonage como uma interface de discagem /VCC/.
  • O UC carrega o ContactPad da Vonage Business Communications como uma interface de discagem /VBC, VBE/.
ccDomain (opcional) [string] Use um domínio de região VCC personalizado. Algumas opções bem conhecidas são:
  • nam.newvoicemedia.com (padrão)
  • emea.newvoicemedia.com
  • apac.newvoicemedia.com
ccAccount (opcional) [string] Use um nome de account VCC personalizado.

placeCall

Alias de atalho para o método de instância placeCall do discador (a ser usado quando a integração não permitir inicialização personalizada).

  • O resultado não é garantido se a função for chamada muito cedo.
Parâmetros Tipo Descrição
phoneNumber [string] Número de telefone para ligar
contactable (opcional) [entityRef] Opcionalmente, forneça um contato preferencial a ser associado aos eventos de interação.

setProvider

Permite trocar o provedor (CC/UC) após a interface do discador ter sido carregada.

Parâmetros Tipo Descrição
provider "cc" / "uc"
  • O CC carrega o ContactPad do Call Center da Vonage como uma interface de discagem /VCC/.
  • O UC carrega o ContactPad da Vonage Business Communications como uma interface de discagem /VBC, VBE/.
ccDomain (opcional) [string] Use um domínio de região VCC personalizado. Algumas opções bem conhecidas são:
  • nam.newvoicemedia.com (padrão)
  • emea.newvoicemedia.com
  • apac.newvoicemedia.com
ccAccount (opcional) [string] Use um nome de account VCC personalizado.

ativarCliqueParaLigar

Ativar/desativar a compilação do SDK na biblioteca de anotação de números de telefone.

Parâmetros Tipo Descrição
enabled [booleano] Marque os números de telefone na página da WEB atual com um ícone do ClickToDial.

definirCódigoDoPaís

Definir o país padrão para o reconhecimento do formato nacional dos números de telefone.

  • Utilizado pela biblioteca de anotações ClickToDial e pelos auxiliares de produtividade da interface do discador UC.
Parâmetros Tipo Descrição
countryCode [string] Código de país de 2 caracteres (Norma ISO 3166-1 alfa-2).

Métodos de instância do SDK Dialer

VonageDialer.init({ debug: true }, (dialer) => {
  dialer // <- dialer instance 
});

setVisibility

Mostrar/ocultar programaticamente o quadro do discador no modo DOT. Este método não tem efeito quando o discador é carregado em um contêiner.

  • No modo DOT, o usuário abre o quadro do ContactPad clicando no botão da Vonage e o oculta ao clicar em qualquer lugar nas áreas ao redor da página.
Parâmetros Tipo Descrição
visible [booleano] Mostrar/ocultar a janela do discador.

setOnDialerEvent

Registre uma função de retorno de chamada para ser executada quando ocorrer um evento do discador.

Parâmetros Tipo Descrição
callback [função] Função de retorno de chamada para processamento de eventos. O parâmetro enviado à função de retorno de chamada é um objeto de modelo polimórfico que possui uma propriedade chamada “type”. Cada tipo de evento possui sua própria estrutura de propriedades.

registerSvgIcon

(Apenas para o UC Dialer) Defina um ícone de integração personalizado para a exibição das configurações e dos contatos.

Parâmetros Tipo Descrição
providerCode [string] Nome programático do provedor de integração personalizado.
dataUrl [string] Imagem SVG codificada em Base64
* Você pode converter qualquer imagem SVG (tamanho recomendado: 64x64 px) em uma URL de dados com um ferramenta online.

placeCall

Faça uma ligação.

Parâmetros Tipo Descrição
phoneNumber [string] Número de telefone para ligar.
contactable (opcional) [entityRef] Opcionalmente, forneça um contato preferencial a ser associado aos eventos de interação.

Modelos de dados do SDK

dialerEvent

Os eventos do Dialer são objetos polimórficos classificados por tipo. O SDK utiliza esses eventos para operações que não exigem resposta do código de integração.

Propriedades Tipo Descrição
type [string] Tipo de evento de interação ou operação:
  • CALL_START - Primeira audiência
  • CALL_ANSWER (*Somente UC) - A chamada está conectada
  • CALL_END - A chamada chegou ao seu estado final
  • CALL_HISTORY (*Somente UC) - O usuário selecionou uma interação na interface da caixa de diálogo de histórico.
  • CHAT_START (*Somente CC)
  • CHAT_END (*Somente CC)
  • PRONTO - O usuário está conectado à interface.
  • LOGOUT - O usuário encerrou a sessão.
  • HEALTH - O status do serviço de telefonia (capacidade de fazer e receber chamadas).
data [objeto] Dados de eventos. Cada tipo possui um esquema de dados diferente.

Tipo de evento CALL_START

O evento é gerado pelo SDK apenas uma vez quando surge uma nova interação (em qualquer estado interno) ou quando há uma chamada ativa após o recarregamento do discador.

Propriedades Tipo Descrição
id [string] Identificador de interação do provedor de telefonia. Esse identificador não é exclusivo para o sistema. Para manter a associação com a interação da Vonage em um armazenamento de terceiros, use o uid em vez disso.
uid [string] Um identificador de interação composto (que garante a verdadeira exclusividade em todo o sistema).
direction "ENTRADA" / "SAÍDA" Direção da interação
phoneNumber [string] Número de telefone da outra parte para interação
state [string] Estado do ciclo de vida da interação (INICIALIZAÇÃO -> TOQUE -> ATIVO -> resultado final).
internal [booleano / indefinido] VERDADEIRO quando se trata de uma comunicação interna da conta da Vonage.
tag (opcional) [string] *Apenas VBC. Marcação de chamadas
contact (opcional) [contato] Contato anexado. Um contato pode ser atribuído com o fazer uma ligação ação.
activity (opcional) [entityRef] Em anexo, referência à atividade de terceiros ainda não concluída/em andamento.

Tipo de evento CALL_ANSWER

` (Apenas UC) O evento é gerado pelo SDK quando a chamada é estabelecida.

Propriedades (herda de Esquema do evento CALL_START) Tipo Descrição
answerDate [data e hora] Hora das respostas.

Tipo de evento CALL_END | CALL_HISTORY

O evento END é gerado pelo SDK quando a interação chega ao seu estado final. O evento HISTORY é gerado quando o usuário seleciona uma chamada concluída no histórico.

Propriedades (herda de Esquema do evento CALL_START) Tipo Descrição
answerDate (opcional) [data e hora] Tempo de resposta (a menos que seja um estado de duração zero).
endDate [data e hora] Hora do lançamento.
  • Caso a integração personalizada tenha interesse na lógica detalhada do estado da chamada, aqui estão algumas constantes de referência que incluem todos os ESTADOS possíveis da chamada e seu ciclo de vida:
const ACTIVE_CALL_STATES = ['INITIALIZING', 'RINGING', 'ACTIVE', 'HELD', 'REMOTE_HELD'];
const TALKING_CALL_STATES = ['ACTIVE', 'HELD', 'REMOTE_HELD'];
const RELEASED_CALL_STATES = ['ANSWERED', 'CANCELLED', 'MISSED', 'REJECTED', 'DETACHED', 'DISCONNECTED'];
const ZERO_DURATION_STATES = ['CANCELLED', 'MISSED', 'REJECTED', 'DISCONNECTED'];

dialerConfig

Opções de configuração para o método init do SDK.

Propriedades Tipo Descrição
debug [booleano]
padrão: false		 Imprimir informações adicionais de depuração no console de JavaScript do navegador.
provider "cc" / "uc"
padrão: "uc"
  • O CC carrega o ContactPad do Call Center da Vonage como uma interface de discagem /VCC/.
  • A UC carrega a Vonage Integration Platform (VGIP) como uma interface de discagem /VBC, VBE/.
ccDomain (Somente CC) [string] Use um domínio de região VCC personalizado. Algumas opções bem conhecidas são:
  • nam.newvoicemedia.com (padrão)
  • emea.newvoicemedia.com
  • apac.newvoicemedia.com
ccAccount (opcional) [string] Use um nome de account VCC personalizado.
features (Apenas UC) [dialerFeatures] Personalizar a interface do discador UC (mostrar/ocultar controles adicionais da interface do usuário).

recursos do discador

Mostrar/ocultar controles adicionais na interface do discador de UC.

Propriedades Tipo Descrição
contactsProvider [booleano]
padrão: false		 Quando ativado, o discador executará a função de retorno de chamada searchContactables configurada quando o usuário digitar um número de telefone no teclado numérico e exibirá os resultados como sugestões de contatos.
openContact [booleano]
padrão: false		 Quando ativado, o discador exibirá um ícone adicional de “abrir link externo” próximo aos contatos na interface. Ao clicar no ícone, a função de retorno de chamada openContact implementada é executada.
openActivity [string] O valor deve ser o providerCode escolhido para a integração personalizada. O Vonage Integrations associa atividades de diferentes fontes de integração aos eventos de interação. O valor é usado como escopo para filtrar apenas as atividades geradas pelo seu provedor de integração personalizada. Quando ativado, o discador de UC exibirá um ícone extra de “nova/abrir nota” no histórico de interações e durante uma chamada ativa. Clicar no ícone executa o callback openActivity implementado.
eventsHistory [booleano]
padrão: true		 Quando ativado, o discador gerará um evento adicional do tipo “CALL_HISTORY” quando o usuário clicar em uma chamada concluída na janela de diálogo do histórico de interações.

com quem se pode entrar em contato

Objeto unificado que representa qualquer entidade de terceiros com nome e número de telefone e que pode representar uma parte envolvida na interação.

Propriedades Tipo Descrição
provider [string] (obrigatório) Código de integração personalizado. Ao visualizar os contatos, a interface do usuário exibe o ícone SVG registrado com o mesmo código de provedor.
id [string] (obrigatório) Identificador externo. A exclusividade do contato na integração personalizada deve ser baseada na combinação de provedor+id+tipo.
type [string] (obrigatório) Tipo programático de entidade externa.
*Os tipos comuns de CRM são: Contato, Lead, Account, Candidato etc.
label [string] (obrigatório) Uma string que representa a entidade externa como texto legível por humanos, de forma que o usuário possa reconhecer que o objeto é o desejado.
*Normalmente, nos CRMs, são o nome e o sobrenome + algumas informações adicionais específicas para a integração.
número de telefone [string] (obrigatório) Número de telefone para contato. Recomenda-se o formato E.164, embora o sistema seja compatível com formatos nacionais quando o código do país estiver definido corretamente.
phoneType [string] (opcional) Rótulo adicional para fins de visualização. Se a integração tiver um contato com dois números (residencial e celular), ela deverá usar dois “contactables” idênticos, diferindo apenas nos campos “phoneNumber” e “phoneType”.
typeLabel [string] (opcional) Nome descritivo para o tipo de entidade programática, para fins de visualização.

entityRef

Objeto unificado que representa qualquer entidade de terceiros, possuindo código de integração, identificador único e tipo

NOTA: O objeto também poderia ser um contato, mas o objetivo não é a visualização (não requer um número de telefone). A referência é transmitida junto com os eventos de interação e pode ser usada para lógica personalizada.

Propriedades Tipo Descrição
provider [string] (obrigatório) Código de integração personalizado.
id [string] (obrigatório) Identificador externo. A exclusividade do contato na integração personalizada deve ser baseada em provedor+id+tipo
type [string] (obrigatório) Tipo programático de entidade externa. *Tipos de CRM, como: Caso, Campanha, Tarefa, etc.
label [string] (opcional) Uma string que representa a entidade externa como texto legível por humanos, suficiente para que o usuário reconheça que o objeto é o desejado.
typeLabel [string] (opcional) Nome descritivo para o tipo de entidade programática, para fins de visualização.