smartMedia

Description:

  • La partie smartmedia d'AgentVoice permet d'accéder aux fonctions et aux évènements de la tâche perso en cours.

La partie smartmedia d'AgentVoice permet d'accéder aux fonctions et aux évènements de la tâche perso en cours.

Members

notification :module:smartMedia/notification

Description:

  • Cet objet permet d'appeler les méthodes getFirstLine() et getSecondLine()

Cet objet permet d'appeler les méthodes getFirstLine() et getSecondLine()

Type:
Example
this.agentVoice.smartMedia.notification.getFirstLine()

preview :module:smartMedia/preview

Description:

  • Cet objet permet d'appeler les méthodes accept() et reject()

Cet objet permet d'appeler les méthodes accept() et reject()

Type:
Example
this.agentVoice.smartMedia.preview.accept()

service :module:smartMedia/service

Description:

  • Pour gérer le service associé à un smartMedia

Pour gérer le service associé à un smartMedia

Type:

Methods

close() → {boolean}

Description:

  • Fermeture de la tâche de SmartMedia en cours

Returns:
Type
boolean

getID() → {number|null}

Description:

  • Permet de récupérer l'id du smartMedia en cours.

Example
const smartMediaId = agentVoice.smartMedia.getID();
Returns:

L'ID du smartMedia ou null s'il n'y a pas de smartMedia en cours.

Type
number | null

getPopupList() → {Array.<object>}

Description:

  • Récupère la liste des remontées de fiches en déclenchement manuel (configuration d'une remonté de fiche propriété Evenement).

Example
//appel de la fonction :

//Récupère la liste des popups manuelles
agentVoice.smartMedia.getPopupList();

//Retour :
[{"id":7,"name":"Nouvelle remontée de fiche 7","type":"RUNEXE"},{"id":8,"name":"nouvelle remontée de fiche 8","type":"HTTPREQUEST"}]}
Returns:

Tableau d'objets "id, name, type". Par exemple : {"id":1,"name":"Remontée de fiche 1","type":"RUNEXE"}
Chaque élément du tableau aura la forme suivante :

  • id : identifiant de la remontée de fiches
  • name : nom de la remontée de fiche configurée lors de sa création
  • type : type de la remontée :
    • HTTPREQUEST : remontée de fiche de type Appel à un web service
    • UDPMESS : remontée de fiche de type message UDP
    • RUNEXE : tous les autres types de remontées de fiches
Type
Array.<object>

onEnd(callback) → {boolean}

Description:

  • Permet de définir une méthode à appeler en cas d'évènement "end".
    Celle-ci se déclenche lorsque l'on termine le traitement d'une intéraction de type "smartMedia".

Example
agentVoice.smartMedia.onEnd(() => {console.log("onEnd");});
Parameters:
Name Type Description
callback function

Méthode à appeler en cas d'évènement "onEnd"
Returns:

True si le callback est bien enregistré, false sinon.

Type
boolean

onError(callback) → {boolean}

Description:

  • Permet de définir une méthode à appeler en cas d'évènement "error".

Example
agentVoice.smartMedia.onError((code, message, params) => {console.log("onError " + code);});
Parameters:
Name Type Description
callback function

Méthode à appeler en cas d'évènement "onError".
Ce callback attend 3 paramètres : code, message et params.

Message peut contenir des informations supplémentaires pour certains codes.
Params peut contenir un objet avec des valeurs utiles à l'erreur.
Returns:

True si le callback est bien enregistré, false sinon.

Type
boolean

onPreview(callback)

Description:

  • Définition du code client à appeler lorsque une preview est reçue

Deprecated:
  • Utiliser agentVoice.smartMedia.preview.onOpen() à la place
Example
// exemple en utilisant une fonction fléchée
agentVoice.smartMedia.onPreview(() => {
     console.log('Execution du code onPreview callback');
});
Parameters:
Name Type Description
callback function

le code client à jouer

onStart(callback) → {boolean}

Description:

  • Permet de définir une méthode à appeler en cas d'évènement "start".
    Celle-ci se déclenche lorsque l'on commence à traiter une intéraction de type "smartMedia".

Example
agentVoice.smartMedia.onStart(() => {console.log("onStart");});
Parameters:
Name Type Description
callback function

Méthode à appeler en cas d'évènement "onStart"
Returns:

True si le callback est bien enregistré, false sinon.

Type
boolean

postpone(postponeDateopt, required_agent_idopt) → {boolean}

Description:

  • Cette fonction permet de représenter une tâche

Examples
//appel de la fonction :
agentVoice.smartMedia.postpone());

//Retour :
true
//Cela renverra la tâche dans la liste des tâches 60 secondes après l'appel de cette fonction
//appel de la fonction :

//Représente la tâche, 120 secondes après l'appel de la fonction
agentVoice.smartMedia.postpone(120, 1));

//Retour :
true
//Cela renverra la tâche à l'agent ayant l'id 1 au bout de 2 minutes (120 secondes)
Parameters:
Name Type Attributes Default Description
postponeDate Date <optional>
 null

Date et heure à laquelle la tâche doit être représentée. Si aucune date, la tâche sera représentée au bout de 60 secondes
required_agent_id number <optional>
 null

Id de l'agent auquel doit être représentée la tâche
Returns:
Type
boolean

remindMe(postponeDateopt) → {boolean}

Description:

  • Cette fonction permet de représenter la tâche à l'agent qui la traite.

Example
//appel de la fonction :

//Rajoute un jour à la date
agentVoice.smartMedia.remindMe(86400);

//Retour :
true
//Cela renverra la tâche à l'agent qui traite la tâche un jour après l'appel à cette méthode
Parameters:
Name Type Attributes Default Description
postponeDate Date <optional>
 null

Date et heure à laquelle la tâche doit être représentée. Si aucune date, la tâche sera représentée au bout de 60 secondes
Returns:
Type
boolean

Members

notification :module:smartMedia/notification

Description:

  • Cet objet permet d'appeler les méthodes getFirstLine() et getSecondLine()

Cet objet permet d'appeler les méthodes getFirstLine() et getSecondLine()

Type:
Example
this.agentVoice.smartMedia.notification.getFirstLine()

preview :module:smartMedia/preview

Description:

  • Cet objet permet d'appeler les méthodes accept() et reject()

Cet objet permet d'appeler les méthodes accept() et reject()

Type:
Example
this.agentVoice.smartMedia.preview.accept()

service :module:smartMedia/service

Description:

  • Pour gérer le service associé à un smartMedia

Pour gérer le service associé à un smartMedia

Type:

Methods

close() → {boolean}

Description:

  • Fermeture de la tâche de SmartMedia en cours

Returns:
Type
boolean

getID() → {number|null}

Description:

  • Permet de récupérer l'id du smartMedia en cours.

Example
const smartMediaId = agentVoice.smartMedia.getID();
Returns:

L'ID du smartMedia ou null s'il n'y a pas de smartMedia en cours.

Type
number | null

getPopupList() → {Array.<object>}

Description:

  • Récupère la liste des remontées de fiches en déclenchement manuel (configuration d'une remonté de fiche propriété Evenement).

Example
//appel de la fonction :

//Récupère la liste des popups manuelles
agentVoice.smartMedia.getPopupList();

//Retour :
[{"id":7,"name":"Nouvelle remontée de fiche 7","type":"RUNEXE"},{"id":8,"name":"nouvelle remontée de fiche 8","type":"HTTPREQUEST"}]}
Returns:

Tableau d'objets "id, name, type". Par exemple : {"id":1,"name":"Remontée de fiche 1","type":"RUNEXE"}
Chaque élément du tableau aura la forme suivante :

  • id : identifiant de la remontée de fiches
  • name : nom de la remontée de fiche configurée lors de sa création
  • type : type de la remontée :
    • HTTPREQUEST : remontée de fiche de type Appel à un web service
    • UDPMESS : remontée de fiche de type message UDP
    • RUNEXE : tous les autres types de remontées de fiches
Type
Array.<object>

onEnd(callback) → {boolean}

Description:

  • Permet de définir une méthode à appeler en cas d'évènement "end".
    Celle-ci se déclenche lorsque l'on termine le traitement d'une intéraction de type "smartMedia".

Example
agentVoice.smartMedia.onEnd(() => {console.log("onEnd");});
Parameters:
Name Type Description
callback function

Méthode à appeler en cas d'évènement "onEnd"
Returns:

True si le callback est bien enregistré, false sinon.

Type
boolean

onError(callback) → {boolean}

Description:

  • Permet de définir une méthode à appeler en cas d'évènement "error".

Example
agentVoice.smartMedia.onError((code, message, params) => {console.log("onError " + code);});
Parameters:
Name Type Description
callback function

Méthode à appeler en cas d'évènement "onError".
Ce callback attend 3 paramètres : code, message et params.

Message peut contenir des informations supplémentaires pour certains codes.
Params peut contenir un objet avec des valeurs utiles à l'erreur.
Returns:

True si le callback est bien enregistré, false sinon.

Type
boolean

onPreview(callback)

Description:

  • Définition du code client à appeler lorsque une preview est reçue

Deprecated:
  • Utiliser agentVoice.smartMedia.preview.onOpen() à la place
Example
// exemple en utilisant une fonction fléchée
agentVoice.smartMedia.onPreview(() => {
     console.log('Execution du code onPreview callback');
});
Parameters:
Name Type Description
callback function

le code client à jouer

onStart(callback) → {boolean}

Description:

  • Permet de définir une méthode à appeler en cas d'évènement "start".
    Celle-ci se déclenche lorsque l'on commence à traiter une intéraction de type "smartMedia".

Example
agentVoice.smartMedia.onStart(() => {console.log("onStart");});
Parameters:
Name Type Description
callback function

Méthode à appeler en cas d'évènement "onStart"
Returns:

True si le callback est bien enregistré, false sinon.

Type
boolean

postpone(postponeDateopt, required_agent_idopt) → {boolean}

Description:

  • Cette fonction permet de représenter une tâche

Examples
//appel de la fonction :
agentVoice.smartMedia.postpone());

//Retour :
true
//Cela renverra la tâche dans la liste des tâches 60 secondes après l'appel de cette fonction
//appel de la fonction :

//Représente la tâche, 120 secondes après l'appel de la fonction
agentVoice.smartMedia.postpone(120, 1));

//Retour :
true
//Cela renverra la tâche à l'agent ayant l'id 1 au bout de 2 minutes (120 secondes)
Parameters:
Name Type Attributes Default Description
postponeDate Date <optional>
 null

Date et heure à laquelle la tâche doit être représentée. Si aucune date, la tâche sera représentée au bout de 60 secondes
required_agent_id number <optional>
 null

Id de l'agent auquel doit être représentée la tâche
Returns:
Type
boolean

remindMe(postponeDateopt) → {boolean}

Description:

  • Cette fonction permet de représenter la tâche à l'agent qui la traite.

Example
//appel de la fonction :

//Rajoute un jour à la date
agentVoice.smartMedia.remindMe(86400);

//Retour :
true
//Cela renverra la tâche à l'agent qui traite la tâche un jour après l'appel à cette méthode
Parameters:
Name Type Attributes Default Description
postponeDate Date <optional>
 null

Date et heure à laquelle la tâche doit être représentée. Si aucune date, la tâche sera représentée au bout de 60 secondes
Returns:
Type
boolean