Type alias StateChangeSuccess

StateChangeSuccess: Msg<{
    agentId: string;
    agentSessionId: string;
    auxCodeId: string;
    changedBy: string | null;
    changedById: string | null;
    changedByName: string | null;
    eventType: "AgentDesktopMessage";
    lastIdleCodeChangeTimestamp: number;
    lastStateChangeReason: string;
    lastStateChangeTimestamp: number;
    orgId: string;
    status: string;
    subStatus: "Available" | "Idle";
    trackingId: string;
    type: "AgentStateChangeSuccess";
}>

Response type received when an agent's state is successfully changed

Type declaration

  • agentId: string

    Unique identifier of the agent

  • agentSessionId: string

    Current session ID of the agent

  • auxCodeId: string

    Auxiliary code ID associated with the new state

  • changedBy: string | null

    Identity of who initiated the state change

  • changedById: string | null

    ID of the user who initiated the change

  • changedByName: string | null

    Name of the user who initiated the change

  • eventType: "AgentDesktopMessage"

    Message type identifier for agent desktop events

  • lastIdleCodeChangeTimestamp: number

    Timestamp of last idle code change

  • lastStateChangeReason: string

    Reason for the state change

  • lastStateChangeTimestamp: number

    Timestamp of current state change

  • orgId: string

    Organization ID the agent belongs to

  • status: string

    Current status of the agent

  • subStatus: "Available" | "Idle"

    Detailed status indicating availability

  • trackingId: string

    Tracking ID for the state change request

  • type: "AgentStateChangeSuccess"

    Type identifier for state change success event

Remarks

Contains information about the agent's new state, including who initiated the change and timestamps for tracking state transitions.