Manage the availability of your users with the iAdvize API

Overview

Managing the availability of your users through the API can meet several integration use cases:

• Synchronize your users' availability between several tools,

• Modify the availability of your users on the different channels according to the current activity,

• View the availability of your users and the number of conversations in progress on each channel in real time.

Prerequisites

API authentication uses temporary and revocable access keys (tokens). Please note that the lifetime of the key is 24 hours.

To generate your access key, please refer to this section.

Steps to follow

Check the availability of a user

The UserAvailability object is available in the user resource in our GraphQL API and allows you to consult the availability and occupation of a user for each channel (chat, call, video, third party channels).

For each channel, the UserChannelAvailability object allows you to know:

• if the channel is activated for this user,

• whether the user is currently available on this channel,

• the number of conversations in progress on this channel, for this user,

• the number of simultaneous contacts allowed on this channel, for this user.

The UserPresence object also lets you know if the user is connected to the solution or not.

Changing the status of a user

The userAvailabilityStatusUpdate resource is available in our GraphQL API and allows you to modify in real time the availability of a user (available/unavailable) for each channel (chat, call, video, third-party channels).

The webhook user.availability.updated allows you to be informed of each change of status of your users (webhook reference)

Good practices

To discover all the resources available to manage your users and their availability, you can consult our GraphQL documentation.