Type alias UserStationLogin

UserStationLogin: {
    auxCodeId: string;
    deviceId?: string | null;
    deviceType?: DeviceType;
    dialNumber?: string | null;
    dn?: string | null;
    isEmergencyModalAlreadyDisplayed?: boolean;
    isExtension?: boolean;
    roles?: string[];
    siteId: string;
    skillProfileId?: string;
    teamId: string | null;
    teamName: string | null;
    usesOtherDN: boolean;
}

Parameters required for agent station login

Type declaration

  • auxCodeId: string

    ID of the initial auxiliary state code

  • Optional deviceId?: string | null

    Unique identifier of the device

  • Optional deviceType?: DeviceType

    Type of device being used

  • Optional dialNumber?: string | null

    Phone number for dialing

  • Optional dn?: string | null

    Directory number

  • Optional isEmergencyModalAlreadyDisplayed?: boolean

    Flag indicating if emergency modal was shown

  • Optional isExtension?: boolean

    Indicates if login is via extension

  • Optional roles?: string[]

    List of roles assigned to the agent

  • siteId: string

    ID of the site where the agent is located

  • Optional skillProfileId?: string

    ID of the agent's skill profile

  • teamId: string | null

    ID of the team the agent belongs to

  • teamName: string | null

    Name of the team

  • usesOtherDN: boolean

    Indicates if agent uses a different DN than their assigned one

Remarks

Contains all the necessary information for logging an agent into their workstation, including team assignments, roles, and device configurations.