Matériel de référence SDK

Méthodes globales du SDK

Init

Acquérir une instance d'API dialer et s'assurer que l'interface dialer est prête (voir Méthodes de l'instance de dialer SDK)

Paramètres Type Description
dialerConfig [objet] Options de configuration du numéroteur.
callback [fonction] Fonction de rappel.

setProvider

Permet de changer de fournisseur (CC/UC) une fois que l'interface du composeur est chargée.

Paramètres Type Description
provider "cc" / "uc"
  • CC charge Vonage Call Center ContactPad en tant qu'interface de numérotation /VCC/.
  • UC charge Vonage Business Communicatons ContactPad en tant qu'interface de numérotation /VBC, VBE/.
ccDomain (facultatif) [chaîne] Utiliser un domaine de région CCV personnalisé. Les options les plus connues sont les suivantes :
  • nam.newvoicemedia.com (par défaut)
  • emea.newvoicemedia.com
  • apac.newvoicemedia.com
ccAccount (facultatif) [chaîne] Utiliser un nom de compte CCV personnalisé.

placeCall

Alias de raccourci de la méthode placeCall de l'instance du composeur (à utiliser lorsque l'intégration ne permet pas une initialisation personnalisée). ne permet pas une initialisation personnalisée).

  • Le résultat n'est pas garanti s'il est appelé trop tôt.
Paramètres Type Description
phoneNumber [chaîne] Numéro de téléphone à composer
contactable (facultatif) [entityRef] Il est possible de transmettre un contact privilégié à associer aux événements d'interaction.

setProvider

Permet de changer de fournisseur (CC/UC) une fois que l'interface du composeur est chargée.

Paramètres Type Description
provider "cc" / "uc"
  • CC charge Vonage Call Center ContactPad en tant qu'interface de numérotation /VCC/.
  • UC charge Vonage Business Communicatons ContactPad en tant qu'interface de numérotation /VBC, VBE/.
ccDomain (facultatif) [chaîne] Utiliser un domaine de région CCV personnalisé. Les options les plus connues sont les suivantes :
  • nam.newvoicemedia.com (par défaut)
  • emea.newvoicemedia.com
  • apac.newvoicemedia.com
ccAccount (facultatif) [chaîne] Utiliser un nom de compte CCV personnalisé.

activerClickToDial

Activer/désactiver la bibliothèque d'annotation des numéros de téléphone intégrée au SDK bibliothèque.

Paramètres Type Description
enabled [booléen] Annoter les numéros de téléphone sur la page WEB en cours avec une icône ClickToDial.

setCountryCode

Définir le pays par défaut pour la reconnaissance des numéros de téléphone au format national reconnaissance.

  • Utilisé par la bibliothèque d'annotation ClickToDial et les aides à la productivité de l'interface UC dialer.
Paramètres Type Description
countryCode [chaîne] Code pays à 2 caractères (Norme ISO 3166-1 alpha-2).

Méthodes d'instance du composeur SDK

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

setVisibility

Afficher/masquer de façon programmée le cadre du composeur en mode DOT en mode DOT. Cette méthode n'a pas d'effet lorsque le composeur est chargé dans un conteneur.

  • En mode DOT, l'utilisateur invoque le cadre ContactPad en cliquant sur le bouton Vonage. sur le bouton Vonage et masque le cadre lorsque l'utilisateur clique n'importe où sur les zones de la page qui l'entourent.
Paramètres Type Description
visible [booléen] Afficher/masquer le cadre du composeur.

setOnDialerEvent

Enregistrer une fonction de rappel à exécuter lorsqu'un événement du composeur se produit.

Paramètres Type Description
callback [fonction] Fonction de rappel pour le traitement des événements. Le paramètre envoyé à la fonction de rappel est un objet de modèle polymorphe ayant une propriété nommée "type". Chaque type d'événement possède sa propre structure de propriétés.

registerSvgIcon

(dialer UC uniquement) Définir une icône d'intégration personnalisée pour la visualisation des paramètres et des contacts.

Paramètres Type Description
providerCode [chaîne] Nom programmatique du fournisseur d'intégration personnalisé.
dataUrl [chaîne] Image SVG encodée en données Base64
* Vous pouvez convertir n'importe quelle image SVG (taille recommandée 64x64px) en une URL de données avec une balise outil en ligne.

placeCall

Passer un appel.

Paramètres Type Description
phoneNumber [chaîne] Numéro de téléphone à composer.
contactable (facultatif) [entityRef] Il est possible de transmettre un contact privilégié à associer aux événements d'interaction.

Modèles de données SDK

dialerEvent

Les événements du composeur sont des objets polymorphes classés par type. Le SDK utilise les événements pour les opérations qui ne nécessitent pas de réponse de la part du code d'intégration.

Propriétés Type Description
type [chaîne] Type d'événement d'interaction ou d'opération :
  • CALL_START - Appel première apparition
  • CALL_ANSWER (*UC uniquement) - L'appel est connecté
  • CALL_END - L'appel a atteint son état final
  • CALL_HISTORY (*UC uniquement) - L'utilisateur a sélectionné une interaction dans l'interface de dialogue de l'historique.
  • CHAT_START (*CC uniquement)
  • CHAT_END (*CC uniquement)
  • READY - L'utilisateur est connecté à l'interface.
  • LOGOUT - L'utilisateur s'est déconnecté.
  • HEALTH - L'état du service de téléphonie (capacité à passer et à recevoir des appels).
data [objet] Données relatives aux événements. Chaque type a un schéma de données différent.

Type d'événement CALL_START

L'événement est généré par le SDK une seule fois lorsqu'une nouvelle interaction apparaît (dans n'importe quel état interne), ou lorsqu'il y a un appel actif après que le composeur a été rechargé.

Propriétés Type Description
id [chaîne] Identifiant d'interaction du fournisseur de téléphonie. Cet identifiant n'est pas unique pour le système. Pour conserver l'association avec l'interaction Vonage dans le stockage d'une tierce partie, utilisez l'uid à la place.
uid [chaîne] Un identifiant d'interaction composite (garantissant une véritable unicité pour l'ensemble du système).
direction "ENTRANT" / "SORTANT" Sens de l'interaction
phoneNumber [chaîne] Numéro de téléphone de la partie distante de l'interaction
state [chaîne] L'état du cycle de vie de l'interaction (INITIALISATION -> SONNERIE -> ACTIF -> disposition finale).
internal [booléen / non défini] VRAI lorsqu'il s'agit d'une communication interne d'un compte Vonage.
tag (facultatif) [chaîne] *VBC uniquement. Marquage des appels
contact (facultatif) [contactable] Contact attaché. Un contact peut être assigné avec l'option placer un appel action.
activity (facultatif) [entityRef] Référence de l'activité d'un tiers non achevée/courante jointe.

Type d'événement CALL_ANSWER

` (UC uniquement) L'événement est généré par le SDK lorsque l'appel est connecté.

Propriétés (étend Schéma de l'événement CALL_START) Type Description
answerDate [datetime] Temps de réponse.

Type d'événement CALL_END CALL_HISTORY

L'événement END est généré par le SDK lorsque l'interaction atteint son état final. L'événement HISTORY est généré lorsque l'utilisateur sélectionne un appel terminé dans l'historique.

Propriétés (étend Schéma de l'événement CALL_START) Type Description
answerDate (facultatif) [datetime] Temps de réponse (sauf s'il s'agit d'un état de durée zéro).
endDate [datetime] Heure de sortie.
  • Au cas où l'intégration personnalisée serait intéressée par la logique fine de l'état des appels, voici quelques constantes d'aide comprenant tous les états d'appel possibles et leur cycle de vie :
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

Options de configuration pour la méthode SDK init.

Propriétés Type Description
debug [booléen]
défaut : false		 Imprimer des informations de débogage supplémentaires dans la console JS du navigateur.
provider "cc" / "uc"
défaut : "uc"
  • CC charge Vonage Call Center ContactPad en tant qu'interface de numérotation /VCC/.
  • UC charge Vonage Integration Platform (VGIP) comme interface de numérotation /VBC, VBE/.
ccDomain (uniquement CC) [chaîne] Utiliser un domaine de région CCV personnalisé. Les options les plus connues sont les suivantes :
  • nam.newvoicemedia.com (par défaut)
  • emea.newvoicemedia.com
  • apac.newvoicemedia.com
ccAccount (facultatif) [chaîne] Utiliser un nom de compte CCV personnalisé.
features (UC uniquement) [dialerFeatures] Personnalisation de l'interface du composeur UC (afficher/masquer les contrôles supplémentaires de l'interface utilisateur).

dialerFeatures

Afficher/masquer des contrôles supplémentaires dans l'interface du composeur UC.

Propriétés Type Description
contactsProvider [booléen]
défaut : false		 Lorsque cette option est activée, le composeur exécute le callback searchContactables configuré lorsque l'utilisateur saisit le numéro de téléphone sur le clavier et affiche les résultats sous forme de suggestions de contacts.
openContact [booléen]
défaut : false		 Lorsque cette option est activée, le composeur affiche une icône supplémentaire "ouvrir un lien externe" près des contacts dans l'interface. Un clic sur l'icône exécute le callback openContact implémenté.
openActivity [chaîne] La valeur doit être le providerCode choisi pour l'intégration personnalisée. Vonage Integrations associe des activités provenant de différentes sources d'intégration aux événements d'interaction. La valeur est utilisée comme champ d'application pour filtrer uniquement les activités générées par votre fournisseur d'intégration personnalisée. Lorsque cette option est activée, le composeur de communications unifiées affiche une icône supplémentaire "nouvelle note/ouvrir" dans l'historique des interactions et lors d'un appel actif. Un clic sur l'icône exécute le callback openActivity implémenté.
eventsHistory [booléen]
par défaut : true		 Lorsque cette option est activée, le composeur génère un événement supplémentaire de type "CALL_HISTORY" lorsque l'utilisateur clique sur un appel terminé dans la boîte de dialogue de l'historique des interactions.

joignable

Objet unifié qui représente toute entité tierce ayant un nom et un numéro de téléphone et qui peut représenter une partie en interaction.

Propriétés Type Description
provider [chaîne] (obligatoire) Code d'intégration personnalisé. Lors de la visualisation des contacts, l'interface utilisateur décore le contact avec l'icône SVG enregistrée ayant le même code fournisseur.
id [chaîne] (obligatoire) Identifiant externe. L'unicité du contact de l'intégration personnalisée doit être basée sur provider+id+type.
type [chaîne] (obligatoire) Type de programme d'une entité externe.
*Les types de CRM les plus courants sont : Contact, Lead, Account, Candidat, etc.
label [chaîne] (obligatoire) Chaîne de caractères représentant l'entité externe sous la forme d'un texte lisible par l'homme, suffisant pour que l'utilisateur reconnaisse qu'il s'agit de l'objet souhaité.
*Habituellement, dans les systèmes de gestion de la relation client, il s'agit du prénom et du nom de famille, ainsi que d'informations supplémentaires spécifiques à l'intégration.
Numéro de téléphone [chaîne] (obligatoire) Numéro de téléphone du contact. Le format recommandé est le format E.164, bien que le système soit compatible avec les formats nationaux lorsque l'indicatif du pays est défini correctement.
phoneType [chaîne] (facultatif) Étiquette supplémentaire à des fins de visualisation. Si l'intégration a un contact avec 2 numéros (domicile et mobile), elle doit utiliser 2 contactables identiques ayant seulement un phoneNumber et un phoneType différents.
typeLabel [chaîne] (facultatif) Etiquette humaine pour le type d'entité programmatique à des fins de visualisation.

entitéRef

Objet unifié qui représente toute entité tierce ayant un code d'intégration, un identifiant unique et un type. un code d'intégration, un identifiant unique et un type

REMARQUE : l'objet pourrait également être un contactable, mais l'objectif n'est pas la visualisation (il n'a pas besoin d'un numéro de téléphone). La référence est transportée avec les événements d'interaction et peut être utilisée pour une logique personnalisée.

Propriétés Type Description
provider [chaîne] (obligatoire) Code d'intégration personnalisé.
id [chaîne] (obligatoire) Identifiant externe. L'unicité du contact de l'intégration personnalisée doit être basée sur provider+id+type.
type [chaîne] (obligatoire) Entité externe de type programmatique. *Type CRM comme : Cas, Campagne, Tâche, etc.
label [chaîne] (facultatif) Chaîne représentant l'entité externe sous forme de texte lisible par l'homme, suffisante pour que l'utilisateur reconnaisse que l'objet est celui qu'il souhaite.
typeLabel [chaîne] (facultatif) Etiquette humaine pour le type d'entité programmatique à des fins de visualisation.