Type alias StationLoginSuccess

StationLoginSuccess: Msg<{
    agentId: string;
    agentSessionId: string;
    auxCodeId: string;
    channelsMap: Record<string, string[]>;
    dialNumber?: string;
    eventType: "AgentDesktopMessage";
    interactionIds: string[];
    lastIdleCodeChangeTimestamp: number;
    lastStateChangeTimestamp: number;
    orgId: string;
    profileType: string;
    roles?: string[];
    siteId: string;
    status: string;
    subStatus: "Available" | "Idle";
    supervisorSessionId?: string;
    teamId: string;
    trackingId: string;
    type: "AgentStationLoginSuccess";
}>

Response type received when an agent successfully logs into their station

Type declaration

  • agentId: string

    Unique identifier of the agent

  • agentSessionId: string

    New session ID assigned to the agent

  • auxCodeId: string

    Auxiliary code ID for initial state

  • channelsMap: Record<string, string[]>

    Map of channel types to channel IDs

  • Optional dialNumber?: string

    Phone number for dialing

  • eventType: "AgentDesktopMessage"

    Message type identifier for agent desktop events

  • interactionIds: string[]

    List of active interaction IDs

  • lastIdleCodeChangeTimestamp: number

    Timestamp of last idle code change

  • lastStateChangeTimestamp: number

    Timestamp of last state change

  • orgId: string

    Organization ID the agent belongs to

  • profileType: string

    Type of agent profile

  • Optional roles?: string[]

    List of roles assigned to the agent

  • siteId: string

    ID of the site where the agent is located

  • status: string

    Current login status

  • subStatus: "Available" | "Idle"

    Current availability status

  • Optional supervisorSessionId?: string

    Session ID of the supervising agent if applicable

  • teamId: string

    ID of the team the agent belongs to

  • trackingId: string

    Tracking ID for the station login request

  • type: "AgentStationLoginSuccess"

    Type identifier for station login success event

Remarks

Represents the success response when an agent logs into their workstation. Includes details about the agent's initial state, assigned teams, and channels.