call

Description:

  • La partie call d'AgentVoice permet de gérer toutes les fonctions, évènements et propriétés d'un appel en cours émis ou reçu.

La partie call d'AgentVoice permet de gérer toutes les fonctions, évènements et propriétés d'un appel en cours émis ou reçu.

Members

consult :module:call/consult

Description:

  • Pour gérer les consultations lors d'une intéraction

Pour gérer les consultations lors d'une intéraction

Type:

directory :module:call/directory

Description:

  • Pour gérer l'annuaire service d'un appel

Pour gérer l'annuaire service d'un appel

Type:

notification :module:call/notification

Description:

  • Pour gérer les notifications lors d'une intéraction

Pour gérer les notifications lors d'une intéraction

Type:

preview :module:call/preview

Description:

  • Pour gérer la preview des campagnes d'appels sortantes

Pour gérer la preview des campagnes d'appels sortantes

Type:

record :module:call/record

Description:

  • Pour gérer les enregistrements durant un appel

Pour gérer les enregistrements durant un appel

Type:

service :module:call/service

Description:

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

Pour gérer le service associé à un appel

Type:

Methods

conference() → {boolean}

Description:

  • Méthode qui permet de passer en conférence entre le client, l'agent et l'appel passé en consultation.
    Il faut d'abord avoir fait un appel en consultation afin de pouvoir passer en conférence les 3 interlocuteurs.

Example
agentVoice.call.conference();
Returns:
Type
boolean

dial(calledNumber, serviceIdopt) → {boolean}

Description:

  • Méthode pour effectuer un appel manuel.

Examples

Avec un seul service d'appel manuel :

agentVoice.call.dial("88888888");
// ou
agentVoice.call.dial(88888888);

En cas de plusieurs services :

agentVoice.call.dial("88888888", 1);
Parameters:
Name Type Attributes Description
calledNumber string | number

Numéro à appeler
serviceId string | number <optional>

Id du service manuel à utiliser. Optionnel si un seul est utilisable dans Kiamo.
Returns:
Type
boolean

getCustomerNumber() → {string|null}

Description:

  • Permet de récupérer le numéro de téléphone utilisé par le client.

Example
const customerNumber = agentVoice.call.getCustomerNumber();
Returns:

Le numéro du client ou null s'il n'y a pas d'appel en cours.

Type
string | null

getID() → {number|null}

Description:

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

Example
const callId = agentVoice.call.getID();
Returns:

L'ID de l'appel ou null s'il n'y a pas d'appel en cours.

Type
number | null

getPopupList() → {Array.<object>}

Description:

  • Permet de récupérer la liste des remontées de fiches manuelles.

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>

hangUpAgent() → {boolean}

Description:

  • Méthode qui permet d'arrêter la conversation en cours avec un client, en raccrochant l'agent.

Example
agentVoice.call.hangUpAgent();
Returns:
Type
boolean

hangUpCustomer() → {boolean}

Description:

  • Méthode qui permet d'arrêter la conversation en cours avec un client, en raccrochant celui-ci.

Example
agentVoice.call.hangUpCustomer();
Returns:
Type
boolean

hold() → {boolean}

Description:

  • Méthode pour mettre en attente un client pendant la conversation avec l'agent.

Example
agentVoice.call.hold();
Returns:
Type
boolean

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 "call".

Example
agentVoice.call.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.call.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 2 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.
Liste non exhaustive des valeurs possibles pour le code :

  • agent_call_failed : Erreur appel agent
  • agent_no_channel : Pas de canal disponible pour l'appel
  • agent_wrong_number : Mauvais numéro de poste
  • agent_busy : Votre poste est occupé
  • agent_no_answer : Vous n'avez pas répondu
  • agent_disc_on_ring : Vous avez raccroché
  • cust_call_failed : Echec de l'appel client
  • cust_disc_on_ring : Le client a raccroché
  • cust_no_channel : Pas de canal disponible
  • cust_wrong_number : Mauvais numéro
  • cust_busy : Occupé
  • cust_no_answer : Pas de réponse
  • cust_answering_machine : Répondeur
  • cust_fax_machine : Fax
  • cust_error_dial : Erreur appel client
  • no_route_found : Aucun faisceau disponible
  • unspecified_error : Erreur non spécifiée
Returns:

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

Type
boolean

onPreview(callback) → {boolean}

Description:

  • Permet de définir une méthode à appeler lors de la réception de la preview par l'agent.

Deprecated:
  • Utiliser agentVoice.call.preview.onOpen() à la place
Example
agentVoice.call.onPreview((can_refuse, timeout) => {console.log("onPreview ");});
Parameters:
Name Type Description
callback function

Méthode à appeler en cas d'évènement "onPreview"
Ce callback attend 2 paramètres : can_refuse et timeout.
can_refuse est un booléen qui indique s'il est possible de refuser la preview.
timeout est une durée en seconde du temps restant pour accepter ou refuser la preview.
Returns:

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

Type
boolean

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 "call".

Example
agentVoice.call.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

retrieve() → {boolean}

Description:

  • Méthode qui permet de reprendre l'appel en cours avec un client mis en attente avant.

Example
agentVoice.call.retrieve();
Returns:
Type
boolean

sendDTMF(key) → {boolean}

Description:

  • Méthode qui permet à l'agent de taper des DTMF lors de son appel.

Example
agentVoice.call.sendDTMF('1');
// ou
agentVoice.call.sendDTMF('#');
Parameters:
Name Type Description
key string

Touche à envoyer. Un chiffre entre 0 et 9, # ou *
Returns:
Type
boolean

transfer(to, calledNumberServiceId, requiredAgentIdopt) → {boolean}

Description:

  • Méthode qui permet de transférer l'appel en cours vers un numéro ou un service d'appel entrant/interne sans consultation de celui-ci au préalable.

Examples

Transfert vers un numéro :

agentVoice.call.transfer('number', 66666666);

Transfert vers un service :

agentVoice.call.transfer('service', 2);

Transfert vers un service et un agent :

agentVoice.call.transfer('service', 2, 5);
Parameters:
Name Type Attributes Description
to string

Une des valeurs possibles : 'number', 'service'
calledNumberServiceId string | number

Numéro où transférer l'appel si to='number', l'Id du service d'appel entrant/interne si to='service'
requiredAgentId string | number <optional>

Id de l'agent requis pour transférer l'appel. Utilisable seulement si to='service'
Returns:
Type
boolean

Members

consult :module:call/consult

Description:

  • Pour gérer les consultations lors d'une intéraction

Pour gérer les consultations lors d'une intéraction

Type:

directory :module:call/directory

Description:

  • Pour gérer l'annuaire service d'un appel

Pour gérer l'annuaire service d'un appel

Type:

notification :module:call/notification

Description:

  • Pour gérer les notifications lors d'une intéraction

Pour gérer les notifications lors d'une intéraction

Type:

preview :module:call/preview

Description:

  • Pour gérer la preview des campagnes d'appels sortantes

Pour gérer la preview des campagnes d'appels sortantes

Type:

record :module:call/record

Description:

  • Pour gérer les enregistrements durant un appel

Pour gérer les enregistrements durant un appel

Type:

service :module:call/service

Description:

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

Pour gérer le service associé à un appel

Type:

Methods

conference() → {boolean}

Description:

  • Méthode qui permet de passer en conférence entre le client, l'agent et l'appel passé en consultation.
    Il faut d'abord avoir fait un appel en consultation afin de pouvoir passer en conférence les 3 interlocuteurs.

Example
agentVoice.call.conference();
Returns:
Type
boolean

dial(calledNumber, serviceIdopt) → {boolean}

Description:

  • Méthode pour effectuer un appel manuel.

Examples

Avec un seul service d'appel manuel :

agentVoice.call.dial("88888888");
// ou
agentVoice.call.dial(88888888);

En cas de plusieurs services :

agentVoice.call.dial("88888888", 1);
Parameters:
Name Type Attributes Description
calledNumber string | number

Numéro à appeler
serviceId string | number <optional>

Id du service manuel à utiliser. Optionnel si un seul est utilisable dans Kiamo.
Returns:
Type
boolean

getCustomerNumber() → {string|null}

Description:

  • Permet de récupérer le numéro de téléphone utilisé par le client.

Example
const customerNumber = agentVoice.call.getCustomerNumber();
Returns:

Le numéro du client ou null s'il n'y a pas d'appel en cours.

Type
string | null

getID() → {number|null}

Description:

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

Example
const callId = agentVoice.call.getID();
Returns:

L'ID de l'appel ou null s'il n'y a pas d'appel en cours.

Type
number | null

getPopupList() → {Array.<object>}

Description:

  • Permet de récupérer la liste des remontées de fiches manuelles.

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>

hangUpAgent() → {boolean}

Description:

  • Méthode qui permet d'arrêter la conversation en cours avec un client, en raccrochant l'agent.

Example
agentVoice.call.hangUpAgent();
Returns:
Type
boolean

hangUpCustomer() → {boolean}

Description:

  • Méthode qui permet d'arrêter la conversation en cours avec un client, en raccrochant celui-ci.

Example
agentVoice.call.hangUpCustomer();
Returns:
Type
boolean

hold() → {boolean}

Description:

  • Méthode pour mettre en attente un client pendant la conversation avec l'agent.

Example
agentVoice.call.hold();
Returns:
Type
boolean

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 "call".

Example
agentVoice.call.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.call.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 2 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.
Liste non exhaustive des valeurs possibles pour le code :

  • agent_call_failed : Erreur appel agent
  • agent_no_channel : Pas de canal disponible pour l'appel
  • agent_wrong_number : Mauvais numéro de poste
  • agent_busy : Votre poste est occupé
  • agent_no_answer : Vous n'avez pas répondu
  • agent_disc_on_ring : Vous avez raccroché
  • cust_call_failed : Echec de l'appel client
  • cust_disc_on_ring : Le client a raccroché
  • cust_no_channel : Pas de canal disponible
  • cust_wrong_number : Mauvais numéro
  • cust_busy : Occupé
  • cust_no_answer : Pas de réponse
  • cust_answering_machine : Répondeur
  • cust_fax_machine : Fax
  • cust_error_dial : Erreur appel client
  • no_route_found : Aucun faisceau disponible
  • unspecified_error : Erreur non spécifiée
Returns:

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

Type
boolean

onPreview(callback) → {boolean}

Description:

  • Permet de définir une méthode à appeler lors de la réception de la preview par l'agent.

Deprecated:
  • Utiliser agentVoice.call.preview.onOpen() à la place
Example
agentVoice.call.onPreview((can_refuse, timeout) => {console.log("onPreview ");});
Parameters:
Name Type Description
callback function

Méthode à appeler en cas d'évènement "onPreview"
Ce callback attend 2 paramètres : can_refuse et timeout.
can_refuse est un booléen qui indique s'il est possible de refuser la preview.
timeout est une durée en seconde du temps restant pour accepter ou refuser la preview.
Returns:

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

Type
boolean

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 "call".

Example
agentVoice.call.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

retrieve() → {boolean}

Description:

  • Méthode qui permet de reprendre l'appel en cours avec un client mis en attente avant.

Example
agentVoice.call.retrieve();
Returns:
Type
boolean

sendDTMF(key) → {boolean}

Description:

  • Méthode qui permet à l'agent de taper des DTMF lors de son appel.

Example
agentVoice.call.sendDTMF('1');
// ou
agentVoice.call.sendDTMF('#');
Parameters:
Name Type Description
key string

Touche à envoyer. Un chiffre entre 0 et 9, # ou *
Returns:
Type
boolean

transfer(to, calledNumberServiceId, requiredAgentIdopt) → {boolean}

Description:

  • Méthode qui permet de transférer l'appel en cours vers un numéro ou un service d'appel entrant/interne sans consultation de celui-ci au préalable.

Examples

Transfert vers un numéro :

agentVoice.call.transfer('number', 66666666);

Transfert vers un service :

agentVoice.call.transfer('service', 2);

Transfert vers un service et un agent :

agentVoice.call.transfer('service', 2, 5);
Parameters:
Name Type Attributes Description
to string

Une des valeurs possibles : 'number', 'service'
calledNumberServiceId string | number

Numéro où transférer l'appel si to='number', l'Id du service d'appel entrant/interne si to='service'
requiredAgentId string | number <optional>

Id de l'agent requis pour transférer l'appel. Utilisable seulement si to='service'
Returns:
Type
boolean