Developer Platform
  • Home
  • Getting Started
    • General Information
    • Features Overview
    • Security
  • APPs
    • Public Apps
      • Shopify
      • Salesforce
      • Zendesk
      • Google Analytics
    • Build your App
      • Getting started
      • My Apps
      • App information
      • App Parameters
      • App Plugins
      • Add Webhooks
      • Submit your Apps
      • App security
      • Developer Policy
  • Use Cases
    • Copilots
      • Product Catalog sync through API
      • FAQ sync through API
    • Visitor experience
      • Integrating custom buttons into your site
      • Check availability before escalating to iAdvize
      • Authenticated Messaging
        • Introduction
        • Web client-side implementation
          • Authenticated Messaging overview
          • Brief timeline of the integration process
          • How to enable authenticated mode in the administration portal?
          • How to implement the customer authentication backend (token provider)?
          • How to authenticate with iAdvize in client's website?
          • How to deal with activation success or failure?
          • How to logout?
          • Compatibility with Mobile SDK
          • FAQ
        • Web backend implementation
          • Important information and recommendations
          • Signature and Encryption Detailed Process
          • Technical backend implementation
          • FAQ
      • Cross-domain Conversation Continuity
      • Customize replies with Markdown
    • Agent workspace
      • Custom App example and step-by-step tutorial
        • Get Started
        • Work with the Desk
        • Intent / Trigger
        • JWT
        • References
    • Administration
      • Users
        • SAML SSO Authentication - Implementation Guide
        • Create, update and delete users via API
        • Manage the availability of your users with the iAdvize API
        • Integrate the iAdvize conversation panel into an existing tool
    • Data & Analytics
      • Anonymize a conversation or visitor data
      • Create a custom dashboard
      • Find contact data using GraphQL
      • Retrieve conversations data
      • Retrieve messages exchanged within a conversation
  • Technologies
    • GraphQL API
      • Terminology
      • Reference
      • Authentication
      • Schema lifecycle
      • Error Management
      • Pagination
    • REST API (deprecated)
      • Statistic (deprecated)
      • Group (deprecated)
      • Call meeting (deprecated)
      • Operator (deprecated)
      • Skill (deprecated)
      • Transaction (deprecated)
      • Visitor (deprecated)
    • Webhooks
      • Reference
      • Guides
    • Desk events
      • Reference
    • Web & Mobile SDK
      • Javascript Web SDK
        • Reference
      • Javascript Callbacks
        • Reference
        • Guides
      • Mobile SDK
        • Fourme (latest)
        • Epoisses
        • Dauphin
        • Cantal
        • 🤝Support Policy
        • 🤔Frequently Asked Questions
    • Custom App
    • External Bot
      • Implementation
        • Configuration flow
        • Conversation flow
        • Conversation objects
      • Configuration
      • FAQ
      • Best practices
Powered by GitBook
On this page
  • Overview
  • Prerequisites
  • Steps to follow
  • Check the availability of a user
  • Changing the status of a user
  • Good practices

Was this helpful?

  1. Use Cases
  2. Administration
  3. Users

Manage the availability of your users with the iAdvize API

PreviousCreate, update and delete users via APINextIntegrate the iAdvize conversation panel into an existing tool

Last updated 1 year ago

Was this helpful?

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 .

Steps to follow

Check the availability of a user

The 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 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.

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).

Good practices

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

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

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

this section
UserAvailability
UserChannelAvailability
UserPresence
GraphQL documentation.
webhook reference