Unblu Agent Embedded JS API
    Preparing search index...

    Interface PersonData

    Representation of a Person (Agent, Visitor or Bot)

    interface PersonData {
        accountId: string;
        authenticationRole: AuthenticationRole;
        avatarUrl?: string;
        displayName?: string;
        email?: string;
        firstName?: string;
        id: string;
        lastName?: string;
        nickname?: string;
        personSource: PersonSource;
        personType: PersonType;
        phone?: string;
        sourceData?: string;
        sourceId: string;
        teamId?: string;
        username: string;
    }
    Index

    Properties

    accountId authenticationRole avatarUrl? displayName? email? firstName? id lastName? nickname? personSource personType phone? sourceData? sourceId teamId? username

    Properties

    accountId: string

    ID of the account the person belongs to

    authenticationRole: AuthenticationRole

    The person's authentication role

    avatarUrl?: string

    URL pointing to the person's avatar

    displayName?: string

    The person's name as displayed in UIs for agents. This is read-only information set by Unblu.

    email?: string

    The person's email address

    firstName?: string

    The person's first name

    id: string

    Unique ID of the person

    lastName?: string

    The person's last name

    nickname?: string

    A name that an anonymous person has given themselves

    personSource: PersonSource

    Source of the person. One of USER_DB or VIRTUAL

    personType: PersonType

    Type of the person

    phone?: string

    The person's phone number

    sourceData?: string

    Vendor-specific custom data unknown to Unblu. It can be passed in by the vendor on person creation/update to store additional information for a person.

    sourceId: string

    Identifier of the person in its source. For USER_DB this is the userId, for VIRTUAL the propagated user ID.

    teamId?: string

    The ID of the team the person belongs to

    username: string

    The person's username

    Settings

    Member Visibility

    On This Page

    Properties