L’API Public d'iAdvize est une interface qui vous permet de transmettre ou de récupérer des données structurées pour interagir avec notre solution afin d’automatiser vos traitements de reporting, d’administration ou encore d’orchestration des services.

Objectif

Vous pouvez utiliser l’API iAdvize pour consulter ou modifier la disponibilité de vos utilisateurs sur chaque canal, de manière instantanée.

Use cases

La gestion de la disponibilité de vos utilisateurs par API peut répondre à plusieurs use case d’intégration:

• Synchroniser la disponibilité de vos utilisateurs entre plusieurs outils,
• Modifier la disponibilité de vos utilisateurs sur les différents canaux selon l’activité en cours,
• Consulter en live la disponibilité des vos utilisateurs et leur nombre de conversations en cours sur chaque canal.

Marche à suivre

1. Pré-requis : récupération de vos clefs API GraphQL 

L’authentification API utilise des clefs d’accès temporaires et révocables.

Veuillez noter que la durée de vie de la clef est de 24 heures.

Vous pouvez générer une clef d’accès en appelant l’url mentionnée dans ce lien avec un email utilisateur et un mot de passe.

2. Consulter la disponibilité d’un utilisateur

L’objet UserAvailability est disponible dans la ressource user dans notre API GraphQL et permet de consulter la disponibilité et l’occupation d’un utilisateur pour chaque canal (chat, call, video, canaux tiers).

Pour chaque canal, l’objet UserChannelAvailability permet de connaître:

• si le canal est activé pour cet utilisateur,
• si l’utilisateur est actuellement disponible sur ce canal,
• le nombre de conversation en cours sur ce canal, pour cet utilisateur,
• le nombre de contacts simultanés autorisés sur ce canal, pour cet utilisateur.

L’objet UserPresence vous permet aussi de savoir si l’utilisateur est connecté ou pas à la solution.

3. Modifier le statut d’un utilisateur

La ressource userAvailabilityStatusUpdate est disponible dans notre API GraphQL et permet de modifier en temps réel la disponibilité d’un utilisateur (available/unavailable) pour chaque canal (chat, call, video, canaux tiers).

Remarque: Le webhook user.availability.updated vous permet d’être informé de chaque changement de statut de vos utilisateurs (documentation)

Pour connaître l’ensemble des ressources disponibles pour gérer vos utilisateurs et leur disponibilité, vous pouvez consulter notre documentation developers platform.