@avaya/infinity-agent-sdk - v1.0.0
    Preparing search index...

    Interface TransferableUser

    An agent who can receive a transferred call.

    Returned in pages by Interaction.getTransferableUsers. Use eligible to filter agents who can actually accept the transfer, and isLoggedInToCx to check whether the agent is currently active. Pass userId in BlindTransferToUserOptions or AttendedTransferToUserOptions to initiate the transfer.

    const page = await interaction.getTransferableUsers({ page: 1, name: "John" });
    const target = page.users.find(u => u.eligible && u.isLoggedInToCx);
    if (target) {
      await interaction.blindTransfer({ userId: target.userId });
    }
    interface TransferableUser {
        userId: string;
        firstName: string;
        lastName: string;
        fullName: string;
        status: string;
        statusType: string;
        eligible: boolean;
        connectedInteractions: number;
        isLoggedInToCx: boolean;
    }
    Index

    Properties

    userId firstName lastName fullName status statusType eligible connectedInteractions isLoggedInToCx

    Properties

    userId: string

    The unique identifier of the agent. Pass this as userId in transfer options.

    firstName: string

    The agent's first name.

    lastName: string

    The agent's last name.

    fullName: string

    The agent's full display name.

    status: string

    The agent's current status label (e.g. "Available", "Offline").

    statusType: string

    The agent's current status type matching ReasonType values (e.g. "available", "offline").

    eligible: boolean

    Whether this agent can receive the transfer. false if the agent is unavailable, at capacity, or not permitted to receive transfers.

    connectedInteractions: number

    The number of interactions the agent is currently handling.

    isLoggedInToCx: boolean

    Whether the agent is currently logged into the CX platform and able to receive interactions.

    Settings

    Member Visibility

    On This Page

    Properties