Introduction

Users within the Conversational Cloud can be agents, agent managers, administrators, or campaign managers. For brands with many agents, the user list may need to be updated regularly. The user entity includes name, picture URL, password, skill, and other important user information.

Note: The current version of the API is 4.0. In order to avoid errors, please add a query parameter to your calls specifying the version, like so:

https://API_REQUEST?v=4.0

UsersOverview

Getting Started

A few things you’ll need to get started with this API:

  1. Retrieve your domain. Use the LivePerson Domain API to retrieve this information by providing the following service name:

    • Read only: accountConfigReadOnly

    • Read/Write: accountConfigReadWrite

  2. This API requires authorization using either a user login or a machine-to-machine authorization.

    • A user token requires login into Conversational Cloud using the Login Service API. Provide a username and password, and receive an authorization token (bearer). Use this token as your authorization header in all API requests.

    • For a machine-to-machine authorizion using OAuth 1.0 App Keys OAuth 2.0 Client Credentials flow

      For the Users API, select the Administration category and check Users

      • OAuth 2.0 Client Credentials flow — follow the instructions, to register an OAuth 2.0 application and generate a JWT access token (Using version 2 of the Authorization API).

      When registering an OAuth 2.0 application for using the Users API, use the “users.external” scope.

  3. Note the API terms of use.

  4. When using this API, it is recommended that you implement our Retry Policy and KeepAlive best practices.

Use Cases for Users API

  • Automatically update user information such as profile picture, email, nickname, or password

  • Automatically update user assignments such as skills, max concurrent chats, or max open messaging conversations

  • Automatically add new agent users to the system

  • Synchronize any HR or staffing system users to Conversational Cloud