directory/agents

Description:

Objet permettant de gérer l'annuaire agents

Objet permettant de gérer l'annuaire agents

Methods

get() → {Array.<object>}

Description:

Permet de récupérer la liste des agents correspondant aux filtres.

Example

const agents = agentVoice.directory.agents.get();

Returns:

liste des agents, tableau d'objet. Un élément de la liste aura la forme suivante :

id: identifiant de l'agent
name: nom de l'agent
mail_address: adresse mail de l'agent
phone_number: numéro de téléphone de l'agent
avatar:avatar de l'agent
- color: couleur de l'icone
- version: version de l'avatar
state: état de l'agent
- id: identifiant de l'état
- type: label de l'état
group: groupe de l'agent
- id: identifiant du groupe
- name: nom du groupe
team: équipe de l'agent
- Si l'agent a une équipe
  - id: identifiant de l'équipe
  - name: nom de l'équipe
- Si l'agent n'a pas d'équipe
  - null
available: agent disponible

Type: Array.<object>

onUpdate(callback)

Description:

Permet de définir une méthode à appeler lors de la réception de la réponse au rafraichissement de l'annuaire agents.

Parameters:

Name	Type	Description
`callback`	function

refresh(filters)

Description:

Permet de rafraichir la liste des agents.

Examples

cas où il n'y a pas de filtre

agentVoice.directory.agents.refresh();

cas où tous les filtres sont renseignés

agentVoice.directory.agents.refresh({"name":"agent kiamo", "group":15, "team":2, "state":"ready"});

cas où seul le filtre name est renseigné

agentVoice.directory.agents.refresh({"name":"agent kiamo"});

cas où seul le filtre teams est renseigné

agentVoice.directory.agents.refresh({"team":15});

cas où seul le filtre state est renseigné

agentVoice.directory.agents.refresh({"state":"ready"});

Parameters:

Name	Type	Default	Description
`filters`	Filters \| null	`null`	`name` : nom de l'agent `group` : identifiant d'un groupe `team` : identifiant d'une équipe `state` : status des agents, valeurs possibles : all, ready, available

Returns:

boolean

Methods

get() → {Array.<object>}

Description:

Permet de récupérer la liste des agents correspondant aux filtres.

Example

const agents = agentVoice.directory.agents.get();

Returns:

liste des agents, tableau d'objet. Un élément de la liste aura la forme suivante :

id: identifiant de l'agent
name: nom de l'agent
mail_address: adresse mail de l'agent
phone_number: numéro de téléphone de l'agent
avatar:avatar de l'agent
- color: couleur de l'icone
- version: version de l'avatar
state: état de l'agent
- id: identifiant de l'état
- type: label de l'état
group: groupe de l'agent
- id: identifiant du groupe
- name: nom du groupe
team: équipe de l'agent
- Si l'agent a une équipe
  - id: identifiant de l'équipe
  - name: nom de l'équipe
- Si l'agent n'a pas d'équipe
  - null
available: agent disponible

Type: Array.<object>

onUpdate(callback)

Description:

Permet de définir une méthode à appeler lors de la réception de la réponse au rafraichissement de l'annuaire agents.

Parameters:

Name	Type	Description
`callback`	function

refresh(filters)

Description:

Permet de rafraichir la liste des agents.

Examples

cas où il n'y a pas de filtre

agentVoice.directory.agents.refresh();

cas où tous les filtres sont renseignés

agentVoice.directory.agents.refresh({"name":"agent kiamo", "group":15, "team":2, "state":"ready"});

cas où seul le filtre name est renseigné

agentVoice.directory.agents.refresh({"name":"agent kiamo"});

cas où seul le filtre teams est renseigné

agentVoice.directory.agents.refresh({"team":15});

cas où seul le filtre state est renseigné

agentVoice.directory.agents.refresh({"state":"ready"});

Parameters:

Name	Type	Default	Description
`filters`	Filters \| null	`null`	`name` : nom de l'agent `group` : identifiant d'un groupe `team` : identifiant d'une équipe `state` : status des agents, valeurs possibles : all, ready, available

Returns:

boolean