SDK-Referenzmaterial

SDK Globale Methoden

Init

Erwerben Sie eine Dialer-API-Instanz und stellen Sie sicher, dass die Dialer-Schnittstelle bereit ist (siehe SDK-Dialer-Instanzmethoden)

Parameter Typ Beschreibung
dialerConfig [Objekt] Optionen für die Wählerkonfiguration.
callback [Funktion] Rückruf-Funktion.

setProvider

Ermöglicht das Umschalten des Providers (CC/UC) nach dem Laden der Dialer-Schnittstelle geladen ist.

Parameter Typ Beschreibung
provider "cc" / "uc"
  • CC lädt Vonage Call Center ContactPad als Dialer-Schnittstelle /VCC/.
  • UC lädt Vonage Business Communicatons ContactPad als Dialer-Schnittstelle /VBC, VBE/.
ccDomain (fakultativ) [string] Verwenden Sie eine benutzerdefinierte VCC-Region-Domäne. Bekannte Optionen sind:
  • nam.newvoicemedia.com (Standard)
  • emea.newvoicemedia.com
  • apac.newvoicemedia.com
ccAccount (fakultativ) [string] Verwenden Sie einen benutzerdefinierten VCC Account-Namen.

placeCall

Kurzer Alias für die Dialer-Instanzmethode placeCall (zu verwenden, wenn Integration keine benutzerdefinierte Initialisierung erlaubt).

  • Das Ergebnis ist nicht garantiert, wenn es zu früh aufgerufen wird.
Parameter Typ Beschreibung
phoneNumber [string] Zu wählende Telefonnummer
contactable (fakultativ) [entityRef] Optional kann ein bevorzugter Kontakt angegeben werden, der mit den Interaktionsereignissen verknüpft werden soll.

setProvider

Ermöglicht das Umschalten des Providers (CC/UC) nach dem Laden der Dialer-Schnittstelle geladen ist.

Parameter Typ Beschreibung
provider "cc" / "uc"
  • CC lädt Vonage Call Center ContactPad als Dialer-Schnittstelle /VCC/.
  • UC lädt Vonage Business Communicatons ContactPad als Dialer-Schnittstelle /VBC, VBE/.
ccDomain (fakultativ) [string] Verwenden Sie eine benutzerdefinierte VCC-Region-Domäne. Bekannte Optionen sind:
  • nam.newvoicemedia.com (Standard)
  • emea.newvoicemedia.com
  • apac.newvoicemedia.com
ccAccount (fakultativ) [string] Verwenden Sie einen benutzerdefinierten VCC Account-Namen.

enableClickToDial

Aktivieren/Deaktivieren der im SDK eingebauten Telefonnummern-Anmerkungen Bibliothek.

Parameter Typ Beschreibung
enabled [boolesch] Markieren Sie Telefonnummern auf der aktuellen WEB-Seite mit einem ClickToDial-Symbol.

setCountryCode

Standardland für Telefonnummern im nationalen Format festlegen Erkennung.

  • Verwendet von der ClickToDial-Anmerkungsbibliothek und UC Dialer-Schnittstelle Produktivitätshelfer.
Parameter Typ Beschreibung
countryCode [string] 2-stelliger Ländercode (ISO 3166-1 Alpha-2-Norm).

SDK Dialer-Instanz Methoden

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

setVisibility

Programmgesteuertes Ein-/Ausblenden des Wählrahmens im DOT Modus. Diese Methode hat keine Wirkung, wenn der Dialer in einem Container geladen ist.

  • Im DOT-Modus ruft der Benutzer den ContactPad-Rahmen auf, indem er auf die Schaltfläche auf die Vonage-Schaltfläche und blendet den Rahmen aus, wenn der Benutzer irgendwo auf die umliegenden Seitenbereiche klickt.
Parameter Typ Beschreibung
visible [boolesch] Ein-/Ausblenden des Wählrahmens.

setOnDialerEvent

Registrieren Sie eine Callback-Funktion, die beim Auftreten eines Dialer-Ereignisses ausgeführt wird.

Parameter Typ Beschreibung
callback [Funktion] Callback-Funktion zur Ereignisverarbeitung. Der Parameter, der an die Callback-Funktion gesendet wird, ist ein polymorphes Modellobjekt mit einer Eigenschaft namens "Typ". Jeder Ereignistyp hat seine eigene Eigenschaftsstruktur.

registerSvgIcon

(nur UC-Dialer) Legen Sie ein benutzerdefiniertes Integrationssymbol für die Visualisierung von Einstellungen und Kontakten fest.

Parameter Typ Beschreibung
providerCode [string] Benutzerdefinierter programmatischer Name des Integrationsanbieters.
dataUrl [string] Base64-Daten kodiertes SVG-Bild
* Sie können jedes SVG-Bild (empfohlene Größe 64x64px) in eine Daten-URL mit einer Online-Tool.

placeCall

Rufen Sie an.

Parameter Typ Beschreibung
phoneNumber [string] Zu wählende Telefonnummer.
contactable (fakultativ) [entityRef] Optional kann ein bevorzugter Kontakt angegeben werden, der mit den Interaktionsereignissen verknüpft werden soll.

SDK-Datenmodelle

dialerEvent

Dialer-Ereignisse sind polymorphe Objekte, die nach Typ kategorisiert sind. Das SDK verwendet Ereignisse für Vorgänge, die keine Antwort vom Integrationscode erfordern.

Eigenschaften Typ Beschreibung
type [string] Interaktions- oder Vorgangsereignistyp:
  • CALL_START - Erstes Erscheinen aufrufen
  • CALL_ANSWER (nur *UC) - Der Anruf ist verbunden
  • CALL_END - Das Gespräch erreichte seinen Endzustand
  • CALL_HISTORY (nur *UC) - Der Benutzer hat eine Interaktion aus dem Verlaufsdialog ausgewählt.
  • CHAT_START (*nur CC)
  • CHAT_END (*nur CC)
  • READY - Der Benutzer ist an der Schnittstelle angemeldet.
  • LOGOUT - Der Benutzer hat sich abgemeldet.
  • HEALTH - Der Status des Telefondienstes (Fähigkeit, Anrufe zu tätigen und entgegenzunehmen).
data [Objekt] Ereignisdaten. Jeder Typ hat ein anderes Datenschema.

Art der Veranstaltung CALL_START

Das Ereignis wird vom SDK nur einmal erzeugt, wenn eine neue Interaktion auftritt (in einem beliebigen internen Zustand), oder wenn nach dem Neuladen des Dialers ein aktiver Anruf erfolgt.

Eigenschaften Typ Beschreibung
id [string] Kennung für die Interaktion mit dem Telefonieanbieter. Diese Kennung ist nicht eindeutig für das System. Um die Assoziation mit der Vonage-Interaktion im Speicher eines Drittanbieters beizubehalten, verwenden Sie stattdessen uid.
uid [string] Ein zusammengesetzter Interaktionsidentifikator (garantiert echte Eindeutigkeit für das gesamte System).
direction "EINGEHEND" / "AUSGEHEND" Richtung der Interaktion
phoneNumber [string] Rufnummer des anderen Teilnehmers
state [string] Interaction fine lifecycle state (INITIALIZING -&gt; RINGING -&gt; ACTIVE -&gt; final disposition).
internal [boolesch / undefiniert] TRUE, wenn es sich um eine interne Kommunikation für einen Vonage Account handelt.
tag (fakultativ) [string] *Nur VBC. Kennzeichnung von Anrufen
contact (fakultativ) [kontaktierbar] Angehängter Kontakt. Ein Kontakt kann mit der Option Platzanruf Aktion.
activity (fakultativ) [entityRef] Beigefügte unvollendete/aktuelle Referenz für Aktivitäten von Dritten.

Art der Veranstaltung CALL_ANSWER

` (nur UC) Das Ereignis wird vom SDK erzeugt, wenn der Anruf verbunden wird.

Eigenschaften (erweitert CALL_START Ereignisschema) Typ Beschreibung
answerDate [datetime] Antwortzeit.

Art der Veranstaltung CALL_END | CALL_HISTORY

Das Ereignis END wird vom SDK erzeugt, wenn die Interaktion ihren Endzustand erreicht. Das Ereignis HISTORY wird erzeugt, wenn der Benutzer einen abgeschlossenen Anruf aus der Historie auswählt.

Eigenschaften (erweitert CALL_START Ereignisschema) Typ Beschreibung
answerDate (fakultativ) [datetime] Antwortzeit (es sei denn, es handelt sich um einen Zustand ohne Dauer).
endDate [datetime] Zeit der Veröffentlichung.
  • Für den Fall, dass die benutzerdefinierte Integration an der feinen Anrufzustandslogik interessiert ist, finden Sie hier einige Hilfskonstanten mit allen möglichen Anrufzuständen und deren Lebenszyklus:
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

Konfigurationsoptionen für die SDK-Init-Methode.

Eigenschaften Typ Beschreibung
debug [boolesch]
Voreinstellung: false		 Zusätzliche Debug-Informationen in der JS-Konsole des Browsers ausgeben.
provider "cc" / "uc"
Standard: "uc"
  • CC lädt Vonage Call Center ContactPad als Dialer-Schnittstelle /VCC/.
  • UC lädt Vonage Integration Platform (VGIP) als Dialer-Schnittstelle /VBC, VBE/.
ccDomain (nur CC) [string] Verwenden Sie eine benutzerdefinierte VCC-Region-Domäne. Bekannte Optionen sind:
  • nam.newvoicemedia.com (Standard)
  • emea.newvoicemedia.com
  • apac.newvoicemedia.com
ccAccount (fakultativ) [string] Verwenden Sie einen benutzerdefinierten VCC Account-Namen.
features (nur UC) [dialerFeatures] Anpassen der UC-Dialer-Schnittstelle (Ein-/Ausblenden zusätzlicher UI-Steuerelemente).

dialerFeatures

Ein-/Ausblenden von zusätzlichen Steuerelementen in der UC-Dialer-Oberfläche.

Eigenschaften Typ Beschreibung
contactsProvider [boolesch]
Voreinstellung: false		 Wenn diese Option aktiviert ist, führt der Dialer den konfigurierten searchContactables-Callback aus, wenn der Benutzer die Telefonnummer in das Dialpad eingibt, und zeigt die Ergebnisse als Kontaktvorschläge an.
openContact [boolesch]
Voreinstellung: false		 Wenn diese Funktion aktiviert ist, zeigt der Dialer ein zusätzliches Symbol "Externen Link öffnen" in der Nähe der Kontakte in der Benutzeroberfläche an. Ein Klick auf das Symbol führt den implementierten openContact Callback aus.
openActivity [string] Der Wert muss der providerCode sein, der für die benutzerdefinierte Integration gewählt wurde. Vonage Integrations fügt den Interaktionsereignissen Aktivitäten aus verschiedenen Integrationsquellen zu. Der Wert wird als Bereich verwendet, um nur die Aktivitäten zu filtern, die von Ihrem benutzerdefinierten Integrationsanbieter generiert werden. Wenn diese Funktion aktiviert ist, zeigt der UC-Dialer in der Interaktionshistorie und während eines aktiven Anrufs ein zusätzliches Symbol für "neue/offene Notiz" an. Ein Klick auf das Symbol führt den implementierten openActivity-Callback aus.
eventsHistory [boolesch]
Standard: true		 Wenn diese Option aktiviert ist, erzeugt der Dialer ein zusätzliches Ereignis vom Typ "CALL_HISTORY", wenn der Benutzer auf einen abgeschlossenen Anruf aus dem Interaktionsverlaufsdialog klickt.

kontaktierbar

Vereinheitlichtes Objekt, das eine beliebige Drittpartei mit Namen und Telefonnummer darstellt und eine Interaktionspartei repräsentieren kann.

Eigenschaften Typ Beschreibung
provider [string] (erforderlich) Benutzerdefinierter Integrationscode. Bei der Visualisierung von Kontakten schmückt die Benutzeroberfläche den Kontakt mit dem registrierten SVG-Symbol, das denselben Anbietercode hat.
id [string] (erforderlich) Externer Bezeichner. Die Einzigartigkeit des benutzerdefinierten Integrationskontakts muss auf Anbieter+Id+Typ basieren.
type [string] (erforderlich) Externe Entität programmatischer Typ.
*Gängige CRM-Typen sind: Kontakt, Lead, Account, Kandidat usw.
label [string] (erforderlich) Eine Zeichenkette, die die externe Entität als menschenlesbaren Text darstellt, der für den Benutzer ausreicht, um zu erkennen, dass es sich um das gewünschte Objekt handelt.
*Normalerweise sind das in CRMs der Vor- und Nachname sowie einige für die Integration spezifische Zusatzinformationen.
TelefonNummer [string] (erforderlich) Kontakt-Telefonnummer. Empfohlen wird das E.164-Format, obwohl das System mit nationalen Formaten kompatibel ist, wenn der Ländercode korrekt eingestellt ist.
phoneType [string] (optional) Extra Etikett für Visualisierungszwecke. Wenn die Integration einen Kontakt mit zwei Nummern hat (Privat und Mobil), muss sie zwei identische Kontakte verwenden, die nur unterschiedliche phoneNumber und phoneType haben.
typeLabel [string] (optional) Menschliche Bezeichnung für den programmatischen Entitätstyp zu Visualisierungszwecken.

entityRef

Vereinheitlichtes Objekt, das eine beliebige 3rd-Party-Einheit mit Integrations Code, eindeutigem Bezeichner und Typ

HINWEIS: Das Objekt könnte auch ein Kontaktobjekt sein, aber der Zweck ist nicht die Visualisierung (es benötigt keine Telefonnummer). Die Referenz wird mit den Interaktionsereignissen übertragen und kann für benutzerdefinierte Logik verwendet werden.

Eigenschaften Typ Beschreibung
provider [string] (erforderlich) Benutzerdefinierter Integrationscode.
id [string] (erforderlich) Externer Bezeichner. Die Einzigartigkeit des benutzerdefinierten Integrationskontakts muss auf Anbieter+Id+Typ basieren
type [string] (erforderlich) Externe Entität programmatischer Typ. *CRM-Typ wie: Fall, Kampagne, Aufgabe, usw..
label [string] (optional) Eine Zeichenkette, die die externe Entität als menschenlesbaren Text darstellt, der für den Benutzer ausreichend ist, um zu erkennen, dass es sich um das gewünschte Objekt handelt.
typeLabel [string] (optional) Menschliche Bezeichnung für den programmatischen Entitätstyp zu Visualisierungszwecken.