Concierge person customization

This article describes the concierge person and how to customize it.

When the concierge takes part in a conversation, it’s represented as a regular virtual person. Unlike agents or visitors, the person has the special type BOT (as do persons used by chatbots).

Every account has a default concierge person, identified by the predefined source ID concierge-bot-person-id. Conversations use the default concierge person unless the conversation template they’re based on specifies a different bot person.

Selecting the concierge bot person

By default, conversations use the account’s default concierge person. In a conversation template, you can select a different bot person to act as the concierge in conversations based on that template. This is useful if your account serves several brands and you want the concierge to have a different name and avatar for each brand.

To select the bot person, set the property com.unblu.conversation.concierge.conciergeBotPerson. The property is only visible if com.unblu.conversation.concierge.conciergeEnabled is set to true.

The Account Configuration interface displays the property as a list of the bot persons in the account, together with an Account default entry. Select Account default to use the account’s default concierge person. Conversations based on the template also use the account’s default concierge person if the property’s value doesn’t correspond to a bot person in the account.

The concierge uses the bot person’s display name and avatar in conversations. For information on creating bot persons, refer to Bot persons in the Aria interface guide.

The property stores the bot person’s source ID, not its person ID. Because you can only set a bot person’s source ID when you create it, the property’s value remains valid for the lifetime of the bot person.

Updating the concierge person

You can update the account’s default concierge person with the Unblu web API, using the /persons/createOrUpdateBot endpoint. You can also edit it in the Unblu Aria interface, like any other bot person.

Listing 1. Request body to change the concierge person’s name

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

If the concierge person doesn’t exist yet, the endpoint creates it.

To change the avatar, add the query parameter expand=avatar to the request and include the avatar in the request body.

Listing 2. Request body to change the concierge person’s avatar

{
    "$_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 with any other person, you can retrieve the concierge person with the Unblu web API, using the /persons/getBySource endpoint. The concierge person is always a virtual person, so set personSource to VIRTUAL. For the account’s default concierge person, set sourceId to concierge-bot-person-id. For a bot person selected on a conversation template, use that bot person’s source ID.

Listing 3. Response body for the account’s default concierge person

{
    "$_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,
    "avatar": "sF9_5JTBRWOnQY1qi8vtlg"
}

To include the avatar in the response, add the query parameter expand=avatar.