- Description:
Objet permettant de gérer les consultations lors d'une intéraction
Objet permettant de gérer les consultations lors d'une intéraction
Methods
dial(calledNumber) → {boolean}
- Description:
Méthode pour effectuer un appel de consultation pendant une intéraction.
Example
agentVoice.call.consult.dial("88888888");
// ou
agentVoice.call.consult.dial(88888888);Parameters:
| Name | Type | Description |
|---|---|---|
calledNumber |
string | number | Numéro à appeler en consultation |
Returns:
- Type
- boolean
hangUp() → {boolean}
- Description:
Méthode permettant de raccrocher le numéro consulté.
Example
agentVoice.call.consult.hangUp();Returns:
- Type
- boolean
hold() → {boolean}
- Description:
Méthode permettant de mettre en attente le numéro consulté.
Example
agentVoice.call.consult.hold();Returns:
- Type
- boolean
onEnd(callback) → {boolean}
- Description:
Permet de définir une méthode à appeler en cas d'évènement "stop".
Celle-ci se déclenche lorsque l'on termine une consultation entrante ou sortante.
Example
agentVoice.call.consult.onEnd(() => {console.log("consult.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.consult.onError(() => {console.log("consult.onError");});Parameters:
| Name | Type | Description |
|---|---|---|
callback |
function | Méthode à appeler en cas d'évènement "onError". |
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 une consultation entrante ou sortante.
Example
agentVoice.call.consult.onStart(() => {console.log("consult.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 permettant de reprendre le numéro consulté.
Example
agentVoice.call.consult.retrieve();Returns:
- Type
- boolean
transfer() → {boolean}
- Description:
Méthode permettant de transférer l'appel en cours vers le numéro appelé en consultation.
Example
agentVoice.call.consult.transfer();Returns:
- Type
- boolean