This document describes version 5 of Unblu. If you’re using the latest major version of Unblu, go to the documentation of the latest version.

The support period for version 5 ended on 22 November 2021. We no longer provide support or updates for this version. You should upgrade to the latest version of Unblu.

Concierge Person

This page is about the Concierge person and how it can be customized.

When the concierge takes part of a conversation, he is represented as a regular virtual person. It is identified by predefined source id: concierge-bot-person-id Unlike agents or visitors, the person has special type: BOT.

There is one concierge person per account.

Updating the concierge person

The concierge person can only be updated with the Web-API using the method:

POST http://<unblu-server>/unblu/rest/v2/persons/createOrUpdateBot

With a body looking like this:

{
    "$_type": "PersonData",
    "personSource": "VIRTUAL",
    "sourceId": "concierge-bot-person-id",
    "firstName": "Custom",
    "lastName": "Concierge",
    "avatar": null
}

if the concierge person did not exist yet (see bellow), it will be created by the method.

If you need to change the Avatar, notice that you can use the expand=avatar query parameter and following body:

{
    "$_type": "PersonData",
    "personSource": "VIRTUAL",
    "sourceId": "concierge-bot-person-id",
    "firstName": "Custom",
    "lastName": "Concierge",
    "avatar": {
        "$_type" : "Avatar",
        "imageData": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAZAAAAGQBAMAAABykSv/AAAABGdBTUEAALGPC/xhBQAAAAFzUkdCAK7OHOkAAAASUExURfolAT39/6qSgZ2hko6xpLeDbrzfdCUAAAFvSURBVHja7c8BDYBADASwBQfvAAkkSOCRgH8rmLgwAq2D1lYZy+hVIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiIiLvjxx7xuyOjI8QERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERedB5hXRH1koRERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERERH5S2Sm3Pdeq7vUBkC2AAAAAElFTkSuQmCC"
  }
}

Getting the concierge person

As any other person, the concierge person can be retrieved using the Web-API. It is a virtual person (personSource is VIRTUAL), and its source id is a constant (sourceId is concierge-bot-person-id):

GET http://<unblu-server>/unblu/rest/v2/persons/findBySource?personSource=VIRTUAL&sourceId=concierge-bot-person-id

The returned body look like this:

{
    "$_type": "PersonData",
    "id": "xalzk-2hTHiGtsoooCZuGQ",
    "accountId": "3MBuodNcTMiUnVIod-qjIQ",
    "personSource": "VIRTUAL",
    "sourceId": "concierge-bot-person-id",
    "sourceData": null,
    "firstName": "Unblu",
    "lastName": "Concierge",
    "username": "unblu.concierge",
    "nickname": null,
    "displayName": "Unblu Concierge",
    "personType": "BOT",
    "authorizationRole": "REGISTERED_USER",
    "email": null,
    "phone": null,
    "teamId": null,
    "teamName": "",
    "avatar": "sF9_5JTBRWOnQY1qi8vtlg"
}

as expected the personType is equals to BOT.

Again if the avatar is relevant, the expand query parameter can be used (with the avatar value).

Lazy creation of the concierge

For each account the concierge person is created only the first time it is needed (when the concierge is activated in a conversation).

Its name is taken from the config properties:

com.unblu.concierge.conciergeInitialFirstName
com.unblu.concierge.conciergeInitialLastName

Its avatar is taken from the branding resources (on premises installation can customize this file).