Material de referencia del SDK

Métodos globales del SDK

Init

Adquirir una instancia de la API de marcación automática y asegurarse de que la interfaz de marcación automática está lista. (véase Métodos de instancia del marcador SDK)

Parámetro Tipo Descripción
dialerConfig [objeto] Opciones de configuración del marcador.
callback [función] Función de devolución de llamada.

setProvider

Permite cambiar de proveedor (CC/UC) después de cargar la interfaz del marcador. cargada.

Parámetros Tipo Descripción
provider "cc" / "uc"
  • CC carga Vonage Call Center ContactPad como interfaz de marcador /VCC/.
  • UC carga Vonage Business Communicatons ContactPad como interfaz de marcador /VBC, VBE/.
ccDomain (opcional) [cadena] Utilizar un dominio de región VCC personalizado. Opciones bien conocidas son:
  • nam.newvoicemedia.com (por defecto)
  • emea.newvoicemedia.com
  • apac.newvoicemedia.com
ccAccount (opcional) [cadena] Utilice un nombre de Account VCC personalizado.

placeCall

Alias de acceso directo al método de instancia de marcador placeCall (para ser utilizado cuando integración no permite la inicialización personalizada).

  • El resultado no está garantizado si se convoca demasiado pronto.
Parámetros Tipo Descripción
phoneNumber [cadena] Número de teléfono que hay que marcar
contactable (opcional) [entityRef] Opcionalmente pasar un contacto preferido que se adjuntará a los eventos de interacción.

setProvider

Permite cambiar de proveedor (CC/UC) después de cargar la interfaz del marcador. cargada.

Parámetros Tipo Descripción
provider "cc" / "uc"
  • CC carga Vonage Call Center ContactPad como interfaz de marcador /VCC/.
  • UC carga Vonage Business Communicatons ContactPad como interfaz de marcador /VBC, VBE/.
ccDomain (opcional) [cadena] Utilizar un dominio de región VCC personalizado. Opciones bien conocidas son:
  • nam.newvoicemedia.com (por defecto)
  • emea.newvoicemedia.com
  • apac.newvoicemedia.com
ccAccount (opcional) [cadena] Utilice un nombre de Account VCC personalizado.

enableClickToDial

Activar/desactivar la anotación de números de teléfono en el SDK biblioteca.

Parámetros Tipo Descripción
enabled [booleano] Anote números de teléfono en la página WEB actual con un icono ClickToDial.

setCodigoPaís

Establezca el país predeterminado para el formato nacional de los números de teléfono reconocimiento.

  • Utilizado por la biblioteca de anotaciones ClickToDial y los ayudantes de productividad de la interfaz de marcación UC ayudantes de productividad de la interfaz del marcador.
Parámetros Tipo Descripción
countryCode [cadena] Código de país de 2 caracteres (Norma ISO 3166-1 alfa-2).

Métodos de instancia de marcador SDK

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

setVisibility

Mostrar/ocultar programáticamente el marco del marcador en modo DOT en modo DOT. Este método no tiene efecto cuando el marcador se carga en un contenedor.

  • En el modo DOT, el usuario invoca el marco ContactPad pulsando en el botón Vonage y oculta el marco cuando el usuario hace clic en cualquier parte de las áreas de página circundantes.
Parámetros Tipo Descripción
visible [booleano] Mostrar/Ocultar el marco del marcador.

setOnDialerEvent

Registra una función callback que se ejecutará cuando se produzca un evento del marcador.

Parámetros Tipo Descripción
callback [función] Función de devolución de llamada de procesamiento de eventos. El parámetro enviado a la función callback es un objeto modelo polimórfico que tiene una propiedad llamada "tipo". Cada tipo de evento tiene su propia estructura de propiedades.

registerSvgIcon

(Sólo marcador UC) Establecer icono de integración personalizado para la visualización de ajustes y contactos.

Parámetros Tipo Descripción
providerCode [cadena] Nombre programático personalizado del proveedor de integración.
dataUrl [cadena] Imagen SVG codificada con datos Base64
* Puede convertir cualquier imagen SVG (tamaño recomendado 64x64px) en una URL de datos con un herramienta en línea.

placeCall

Haz una llamada.

Parámetros Tipo Descripción
phoneNumber [cadena] Número de teléfono que hay que marcar.
contactable (opcional) [entityRef] Opcionalmente pasar un contacto preferido que se adjuntará a los eventos de interacción.

Modelos de datos del SDK

dialerEvent

Los eventos de marcador son objetos polimórficos categorizados por tipo. El SDK utiliza eventos para operaciones que no requieren respuesta del código de integración.

Propiedades Tipo Descripción
type [cadena] Tipo de evento de interacción u operación:
  • CALL_START - Llamar a la primera comparecencia
  • CALL_ANSWER (sólo *UC) - La llamada está conectada
  • CALL_END - La llamada alcanzó su estado final
  • CALL_HISTORY (Sólo *UC) - El usuario seleccionó una interacción de la interfaz de diálogo del historial.
  • CHAT_START (*sólo CC)
  • CHAT_END (*sólo CC)
  • LISTO - El usuario ha iniciado sesión en la interfaz.
  • LOGOUT - El usuario ha cerrado la sesión.
  • HEALTH - El estado del servicio de telefonía (capacidad de realizar y recibir llamadas).
data [objeto] Datos de sucesos. Cada tipo tiene un esquema de datos diferente.

Tipo de acontecimiento CALL_START

El evento es generado por el SDK sólo una vez cuando una nueva interacción aparece (en cualquier estado interno), o cuando hay una llamada activa después de recargar el marcador.

Propiedades Tipo Descripción
id [cadena] Identificador de interacción con el proveedor de telefonía. Este identificador no es único para el sistema. Para mantener la asociación con la interacción de Vonage en el almacenamiento de terceros, utiliza uid en su lugar.
uid [cadena] Un identificador de interacción compuesto (garantiza la unicidad real para todo el sistema).
direction "ENTRADA" / "SALIDA" Dirección de la interacción
phoneNumber [cadena] Interacción número de teléfono de la parte remota
state [cadena] Interacción fina estado del ciclo de vida (INICIALIZANDO -> RINGING -> ACTIVO -> disposición final).
internal [booleano / indefinido] TRUE cuando se trata de una comunicación interna de una Account de Vonage.
tag (opcional) [cadena] *Sólo VBC. Etiquetado de llamadas
contact (opcional) [contactable] Contacto asignado. Se puede asignar un contacto con el realizar llamada acción.
activity (opcional) [entityRef] Se adjunta referencia de actividad de terceros no finalizada/actual.

Tipo de acontecimiento CALL_ANSWER

` (sólo UC) El evento es generado por el SDK cuando se conecta la llamada.

Propiedades (extiende Esquema del evento CALL_START) Tipo Descripción
answerDate [datetime] Tiempo de respuesta.

Tipo de acontecimiento CALL_END | CALL_HISTORY

El evento FIN es generado por el SDK cuando la interacción alcanza su estado final. El evento HISTORIA se genera cuando el usuario selecciona una llamada completada del historial.

Propiedades (extiende Esquema del evento CALL_START) Tipo Descripción
answerDate (opcional) [datetime] Tiempo de respuesta (a menos que se trate de un estado de duración cero).
endDate [datetime] Tiempo de liberación.
  • En caso de que la integración personalizada esté interesada en la lógica fina del estado de llamada, aquí hay algunas constantes de ayuda que incluyen todos los posibles ESTADOS de llamada y su 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

Opciones de configuración para el método SDK init.

Propiedades Tipo Descripción
debug [booleano]
por defecto: false		 Imprime información de depuración adicional en la consola JS del navegador.
provider "cc" / "uc"
por defecto: "uc"
  • CC carga Vonage Call Center ContactPad como interfaz de marcador /VCC/.
  • UC carga Vonage Integration Platform (VGIP) como interfaz de marcador /VBC, VBE/.
ccDomain (sólo CC) [cadena] Utilizar un dominio de región VCC personalizado. Opciones bien conocidas son:
  • nam.newvoicemedia.com (por defecto)
  • emea.newvoicemedia.com
  • apac.newvoicemedia.com
ccAccount (opcional) [cadena] Utilice un nombre de Account VCC personalizado.
features (sólo UC) [dialerFeatures] Personalizar la interfaz del marcador UC (mostrar/ocultar controles adicionales de la interfaz de usuario).

marcadorCaracterísticas

Mostrar/Ocultar controles adicionales en la interfaz del marcador UC.

Propiedades Tipo Descripción
contactsProvider [booleano]
por defecto: false		 Si se activa, el marcador ejecutará la llamada de retorno searchContactables configurada cuando el usuario introduzca el número de teléfono del teclado y mostrará los resultados como sugerencias de contactos.
openContact [booleano]
por defecto: false		 Cuando se activa, el marcador visualizará un icono extra de "abrir enlace externo" cerca de los contactos dentro de la interfaz. Al hacer clic en el icono se ejecuta la llamada de retorno openContact implementada.
openActivity [cadena] El valor debe ser el providerCode elegido para la integración personalizada. Vonage Integrations adjunta actividades de diferentes fuentes de integración a los eventos de interacción. El valor se utiliza como ámbito para filtrar sólo las actividades generadas por tu proveedor de integración personalizado. Cuando está habilitado, el marcador UC visualizará un ícono adicional de "nota nueva/abierta" en el historial de interacciones y durante una llamada activa. Al hacer clic en el icono se ejecuta la llamada de retorno openActivity implementada.
eventsHistory [booleano]
por defecto: true		 Cuando se habilita, el marcador generará un evento extra de tipo "CALL_HISTORY" cuando el usuario haga clic en una llamada completada desde el diálogo del historial de interacciones.

contactable

Objeto unificado que representa cualquier entidad de terceros con nombres y número de teléfono y puede representar una parte de interacción.

Propiedades Tipo Descripción
provider [cadena] (obligatorio) Código de integración personalizado. Al visualizar los contactos, la interfaz de usuario decora el contacto con el icono SVG registrado que tenga el mismo código de proveedor.
id [cadena] (obligatorio) Identificador externo. La unicidad del contacto de integración personalizado debe basarse en proveedor+id+tipo.
type [cadena] (obligatorio) Tipo programático de entidad externa.
*Los tipos de CRM más comunes son: Contacto, Cliente potencial, Account, Candidato, etc.
label [cadena] (obligatorio) Cadena que representa la entidad externa en forma de texto legible por humanos, suficiente para que el usuario reconozca que el objeto es el deseado.
*Normalmente en los CRMs es el Nombre y Apellidos + alguna información extra específica para la integración.
phoneNumber [cadena] (obligatorio) Número de teléfono de contacto. Se recomienda el formato E.164, aunque el sistema es compatible con formatos nacionales cuando el código de país está configurado correctamente.
phoneType [cadena] (opcional) Etiqueta extra para fines de visualización. Si la integración tiene un contacto con 2 números (casa y móvil), debe utilizar 2 contactables idénticos que tengan sólo phoneNumber y phoneType diferentes.
typeLabel [cadena] (opcional) Etiqueta humana para el tipo de entidad programática con fines de visualización.

entityRef

Objeto unificado que representa cualquier entidad de terceros con código de integración código, identificador único y tipo

NOTA: El objeto también podría ser un contactable, pero el propósito no es la visualización (no requiere un número de teléfono). La referencia se lleva con los eventos de interacción y podría ser utilizado para la lógica personalizada.

Propiedades Tipo Descripción
provider [cadena] (obligatorio) Código de integración personalizado.
id [cadena] (obligatorio) Identificador externo. La unicidad del contacto de integración personalizado debe basarse en proveedor+id+tipo
type [cadena] (obligatorio) Entidad externa de tipo programático. *Tipo CRM como: Caso, Campaña, Tarea, etc.
label [cadena] (opcional) Una cadena que representa la entidad externa como texto legible por humanos, suficiente para que el usuario reconozca que el objeto es el deseado.
typeLabel [cadena] (opcional) Etiqueta humana para el tipo de entidad programática con fines de visualización.