Class User

The primary entry point for all agent operations in the Avaya Infinity platform.

A User instance is obtained by calling AvayaInfinityAgentSdk.init after a successful OAuth authentication. It is the single object through which your application drives the full agent lifecycle - from CX login to receiving and managing interactions, controlling agent status, accessing queue assignments, and configuring audio devices.

Typical usage flow

Authenticate and initialise - call AvayaInfinityAgentSdk.init() to get a User.
Subscribe to events - register handlers for UserEventType events before logging into CX so no events are missed.
Log into CX — call loginToCx to make the agent available to receive interactions. The agent cannot receive calls or chats until this completes.
Set agent status — use getAssignableReasonCodes and changeStatus to place the agent in the correct availability state.
Handle incoming interactions - incoming interactions arrive via the UserEventType.INTERACTION_RECEIVED event.
Create outbound interactions - Outbound calls can be initiated with createOutboundVoiceInteraction if canCreateOutboundVoiceInteraction is true.
Clean up - call logoutFromCx before destroying the SDK session.

Index of methods and attributes

Area	Key methods or attributes
Identity	userId, userEmail, userFullName, userFirstName, userLastName, accountId
Status	currentStatus, getAssignableReasonCodes, canChangeStatus, changeStatus, refreshStatus
CX Login	isLoggedInToCx, canLoginToCx, loginToCx, canLogoutFromCx, logoutFromCx
Queues	defaultOutboundQueue, getAssignedQueues, refreshAssignedQueues
Interactions	getAssignedInteractions, createOutboundVoiceInteraction, canCreateOutboundVoiceInteraction
Capabilities	isEliteVoiceEnabled, isInteractionAutoAcceptEnabled
Viewing Interactions	viewInteraction, getInteractionViews, canViewInteractionPublicly, canViewInteractionPrivately, canClaimInteractionOwnership
Audio devices	getAvailableAudioDevices, getSelectedAudioDevices, canSetAudioInputDevice, setAudioInputDevice, canSetAudioOutputDevice, setAudioOutputDevice, getAudioDevicePermissionState
WebRTC	getWebRtcRegistrationState
Events	subscribe, unsubscribe

Reactivity

The SDK maintains a single User instance for the session and mutates its fields in place as state changes — the object reference is stable across updates. The same holds for the collections it exposes (Interaction, Queue, and so on). Framework consumers (React, Vue, etc.) that rely on reference equality for change detection must therefore trigger their own re-render on each subscribed event — for example by bumping a version counter, re-emitting the enclosing array, or lifting the data into a store that produces a fresh snapshot per event.

See

Implements

UserTrait

Index

CX Login

canLoginToCx

canLoginToCx(): boolean
Indicates whether the agent is currently allowed to log in to the CX platform

Use this to check the precondition before calling loginToCx.

Returns boolean
true if the agent can log in to CX, false otherwise

Implementation of UserTrait.canLoginToCx

loginToCx

loginToCx(reasonCode?: ReasonCode): Promise<void>
Logs the agent into the CX platform

Must be called before the agent can receive interactions. When reasonCode is provided, a non-Elite agent is logged in and set to that status in a single request. Elite Voice agents must call loginToCx() without a reason, wait for login to complete, and then call changeStatus explicitly.
Parameters
- OptionalreasonCode: ReasonCode
  Optional initial ReasonCode from getAssignableReasonCodes.
Returns Promise<void>
A promise that resolves when CX login is complete
Throws
If login fails (code ASE-2007)

Throws
If the status type is invalid (code ASE-2001)

Throws
If the reason code is not recognized (code ASE-2002)

Throws
If the Elite aux code is missing (code ASE-2016)

Throws
If an Elite agent supplies an initial status (code ASE-2019)
Example
```
await user.loginToCx();
console.log("Logged into CX:", user.isLoggedInToCx);
```
Example
```
const reasons = await user.getAssignableReasonCodes();
const available = reasons.find(r => r.type === ReasonType.AVAILABLE);
if (available) {
  await user.loginToCx(available);
}
```
Implementation of UserTrait.loginToCx

canLogoutFromCx

canLogoutFromCx(): boolean
Indicates whether the agent is currently allowed to log out from the CX platform

Use this to check the precondition before calling logoutFromCx.

Returns boolean
true if the agent can log out from CX, false otherwise

Implementation of UserTrait.canLogoutFromCx

logoutFromCx

logoutFromCx(reasonCode: ReasonCode): Promise<void>
Logs the agent out from the CX platform
Parameters
- reasonCode: ReasonCode
  The ReasonCode describing why the agent is logging out. Must be a LOGOUT-type reason obtained from getAssignableReasonCodes.
Returns Promise<void>
A promise that resolves when CX logout is complete
Throws
If logout fails (code ASE-2008)
Example
```
const reasons = await user.getAssignableReasonCodes();
const logoutReason = reasons.find(r => r.type === ReasonType.LOGOUT);
if (logoutReason) {
  await user.logoutFromCx(logoutReason);
}
```
Implementation of UserTrait.logoutFromCx

isLoggedInToCx

get isLoggedInToCx(): boolean
Indicates whether the agent is currently logged into the CX platform

Returns boolean
true if the agent is logged in to CX, false otherwise

Implementation of UserTrait.isLoggedInToCx

Capabilities

canCreateOutboundVoiceInteraction

get canCreateOutboundVoiceInteraction(): boolean
Indicates whether the agent has permission to initiate outbound calls

Returns boolean
true if outbound call creation is permitted, false otherwise

Implementation of UserTrait.canCreateOutboundVoiceInteraction

isEliteVoiceEnabled

get isEliteVoiceEnabled(): boolean
Indicates whether the agent is licensed for Avaya Elite Voice (hybrid agent).

Hybrid agents handle voice via Elite Voice.

Returns boolean
true if Elite Voice is enabled for this user, false otherwise

Implementation of UserTrait.isEliteVoiceEnabled

isInteractionAutoAcceptEnabled

get isInteractionAutoAcceptEnabled(): boolean
Whether auto-accept is enabled for the agent's incoming interactions.

When true, the SDK accepts incoming interactions on the agent's behalf across all channels. Auto-accept is suppressed for an audio interaction when another audio interaction is already in progress.

While the SDK is auto-accepting an interaction, Interaction.canAccept returns false, and the resulting InteractionEventType.INTERACTION_ACCEPTED event carries payload.isAutoAccepted = true.

Returns boolean
true if auto-accept is enabled for this agent, false otherwise

Implementation of UserTrait.isInteractionAutoAcceptEnabled

Events

subscribe<T extends UserEventType>(
eventName: T,
handler: UserEventHandler<T>,
): string
Subscribes to agent events
Type Parameters
- T extends UserEventType
Parameters
- eventName: T
  The UserEventType to subscribe to
- handler: UserEventHandler<T>
  Callback invoked each time the event fires
Returns string
A handler ID to pass to unsubscribe when done
Example
```
const handlerId = user.subscribe(
  UserEventType.USER_STATUS_CHANGED,
  (event) => {
    console.log("Status changed to:", event.payload.status.type);
  }
);
```
Implementation of UserTrait.subscribe

unsubscribe

unsubscribe(eventName: UserEventType, handlerId: string): void
Unsubscribes a previously registered event handler
Parameters
- eventName: UserEventType
  The UserEventType to unsubscribe from
- handlerId: string
  The handler ID returned from subscribe
Returns void
Implementation of UserTrait.unsubscribe

Identity

userId

get userId(): string
The unique identifier for this agent

Returns string
The agent's user ID

Implementation of UserTrait.userId

userEmail

get userEmail(): string
The agent's email address

Returns string
The agent's email

Implementation of UserTrait.userEmail

userFullName

get userFullName(): string
The agent's full display name

Returns string
The agent's full name

Implementation of UserTrait.userFullName

userFirstName

get userFirstName(): string
The agent's first name

Returns string
The agent's first name

Implementation of UserTrait.userFirstName

userLastName

get userLastName(): string
The agent's last name

Returns string
The agent's last name

Implementation of UserTrait.userLastName

accountId

get accountId(): string
The tenant identifier for the logged-in agent.

Platform-assigned, session-level constant - the same value across every interaction the agent handles in the session.

Returns string
The agent's account/tenant ID

Implementation of UserTrait.accountId

Interactions

getAssignedInteractions

getAssignedInteractions(): Interaction[]
Returns the agent's currently active interactions

Returns the cached list. Subscribe to UserEventType.INTERACTION_RECEIVED, UserEventType.INTERACTION_CREATED, and UserEventType.INTERACTION_VIEWING_STARTED to track changes.

Returns Interaction[]
An array of assigned Interaction objects

Implementation of UserTrait.getAssignedInteractions

createOutboundVoiceInteraction

createOutboundVoiceInteraction(
params: CreateOutboundVoiceInteractionParams,
): Promise<Interaction>
Creates and initiates an outbound call interaction

Resolves when the call has been connected and media is set up.
Parameters
- params: CreateOutboundVoiceInteractionParams
  Parameters for User.createOutboundVoiceInteraction.
  - OptionalqueueId?: string
    The ID of the queue to route the call through.
    
    Required for standard agents. Optional for Elite (hybrid) agents ({@link UserTrait.isEliteVoiceEnabled} === true).
  - phoneNumber: string
    The destination phone number to call
  - Optionalcustomer?: OutboundCustomerDetails
    Optional pre-fill data for the customer being called (name, email, language code).
  - Optionaldetails?: AdditionalInteractionDetails
    Optional additional details for the interaction
Returns Promise<Interaction>
A promise that resolves to the new Interaction once the call is active
Throws
If the call could not be created (code ASE-2006)
Example
```
if (user.canCreateOutboundVoiceInteraction) {
  const interaction = await user.createOutboundVoiceInteraction({
    queueId: "queue-123",
    phoneNumber: "+15551234567",
  });
  console.log("Call started:", interaction.interactionId);
}
```
Implementation of UserTrait.createOutboundVoiceInteraction

canCreateOutboundVoiceInteraction

get canCreateOutboundVoiceInteraction(): boolean
Indicates whether the agent has permission to initiate outbound calls

Returns boolean
true if outbound call creation is permitted, false otherwise

Implementation of UserTrait.canCreateOutboundVoiceInteraction

Media

getWebRtcRegistrationState

getWebRtcRegistrationState(): WebRtcRegistrationState
Returns the current WebRTC registration status

Reflects the state of the agent's voice channel registration with the media server. Subscribe to WebRtcRegistrationEventType events for change notifications.

Returns WebRtcRegistrationState
The current WebRtcRegistrationState

Implementation of UserTrait.getWebRtcRegistrationState

getAvailableAudioDevices

getAvailableAudioDevices(): Promise<AvailableAudioDevices>
Returns the available audio input and output devices

If microphone permission has not been granted, device names may be hidden and returned as generic labels such as Unknown audioinput. This method does not request microphone permission.

Returns Promise<AvailableAudioDevices>
A promise that resolves to the AvailableAudioDevices listing all input and output devices
Throws
If microphone permission is denied (code ASE-4002)

Throws
If device enumeration is unavailable or fails (code ASE-4001)
Example
```
const devices = await user.getAvailableAudioDevices();
console.log("Inputs:", devices.inputDevices.map(d => d.label));
console.log("Outputs:", devices.outputDevices.map(d => d.label));
```
Implementation of UserTrait.getAvailableAudioDevices

getSelectedAudioDevices

getSelectedAudioDevices(): SelectedAudioDevices
Returns the currently selected audio input and output devices

Returns SelectedAudioDevices
The SelectedAudioDevices representing the active input and output device selection
Example
```
const selected = user.getSelectedAudioDevices();
console.log("Active microphone:", selected.inputDevice?.label);
console.log("Active speaker:", selected.outputDevice?.label);
```
Implementation of UserTrait.getSelectedAudioDevices

canSetAudioInputDevice

canSetAudioInputDevice(): boolean
Indicates whether an audio input device can currently be set

Use this to check the precondition before calling setAudioInputDevice.

Returns boolean
true if an audio input device can be set, false otherwise

Implementation of UserTrait.canSetAudioInputDevice

setAudioInputDevice

setAudioInputDevice(deviceId: string): void
Sets the active audio input device

The deviceId must be one of the IDs from getAvailableAudioDevices.
Parameters
- deviceId: string
  The ID of the input device to use
Returns void
Throws
If the device ID is not found (code ASE-2004)
Example
```
const devices = await user.getAvailableAudioDevices();
const preferred = devices.inputDevices.find(d => d.label.includes("Headset"));
if (preferred) {
  user.setAudioInputDevice(preferred.deviceId);
}
```
Implementation of UserTrait.setAudioInputDevice

canSetAudioOutputDevice

canSetAudioOutputDevice(): boolean
Indicates whether an audio output device can currently be set

Use this to check the precondition before calling setAudioOutputDevice.

Returns boolean
true if an audio output device can be set, false otherwise

Implementation of UserTrait.canSetAudioOutputDevice

setAudioOutputDevice

setAudioOutputDevice(deviceId: string): void
Sets the active audio output device

The deviceId must be one of the IDs from getAvailableAudioDevices.
Parameters
- deviceId: string
  The ID of the output device to use
Returns void
Throws
If the device ID is not found (code ASE-2004)
Example
```
const devices = await user.getAvailableAudioDevices();
const preferred = devices.outputDevices.find(d => d.label.includes("Headset"));
if (preferred) {
  user.setAudioOutputDevice(preferred.deviceId);
}
```
Implementation of UserTrait.setAudioOutputDevice

getAudioDevicePermissionState

getAudioDevicePermissionState(): MediaDevicePermissionState
Returns the current microphone permission state

Use this to check permission before calling getAvailableAudioDevices, which will trigger a browser permission prompt if not yet granted.

Returns MediaDevicePermissionState
The current MediaDevicePermissionState
Example
```
const state = user.getAudioDevicePermissionState();
if (state === MediaDevicePermissionState.GRANTED) {
  const devices = await user.getAvailableAudioDevices();
}
```
Implementation of UserTrait.getAudioDevicePermissionState

Queues

getAssignedQueues

getAssignedQueues(): Queue[]
Returns the list of queues currently assigned to this agent

Returns the cached list. Call refreshAssignedQueues to fetch the latest assignments from the server.

Returns Queue[]
An array of Queue objects assigned to this agent

Implementation of UserTrait.getAssignedQueues

defaultOutboundQueue

get defaultOutboundQueue(): Queue | undefined
The configured default outbound queue when this SDK session was initialized or most recently logged into CX.

Returns undefined for Elite Voice users or when the outbound queue is not configured.

Returns Queue | undefined
The default outbound queue, or undefined when not configured

Implementation of UserTrait.defaultOutboundQueue

refreshAssignedQueues

refreshAssignedQueues(): Promise<Queue[]>
Refreshes the agent's queue assignments from the server

After this resolves, getAssignedQueues returns the updated list.

Returns Promise<Queue[]>
A promise that resolves to the updated list of Queue objects
Example
```
await user.refreshAssignedQueues();
const queues = user.getAssignedQueues();
console.log("Assigned queues:", queues.map(q => q.queueName));
```
Implementation of UserTrait.refreshAssignedQueues

Status Management

currentStatus

get currentStatus(): ReasonCode
The agent's current status

Reflects the most recently applied status. Subscribe to UserEventType.USER_STATUS_CHANGED for change notifications.

Returns ReasonCode
The current ReasonCode status

Implementation of UserTrait.currentStatus

refreshStatus

refreshStatus(): Promise<ReasonCode>
Fetches the agent's current status from the server

Returns Promise<ReasonCode>
A promise that resolves to the current ReasonCode status
Throws
If the request fails (code ASE-2005)
Example
```
const status = await user.refreshStatus();
console.log("Current status:", status.type);
```
Implementation of UserTrait.refreshStatus

getAssignableReasonCodes

getAssignableReasonCodes(): Promise<ReasonCode[]>
Fetches the available reason codes for status changes

Use the returned reasons to pass the selected ReasonCode to changeStatus.

Returns Promise<ReasonCode[]>
A promise that resolves to an array of available ReasonCode objects
Throws
If the request fails (code ASE-2005)
Example
```
const reasons = await user.getAssignableReasonCodes();
const available = reasons.find(r => r.type === ReasonType.AVAILABLE);
if (available) {
  await user.changeStatus(available);
}
```
Implementation of UserTrait.getAssignableReasonCodes

canChangeStatus

canChangeStatus(): boolean
Indicates whether the agent can currently change their status

Use this to check the precondition before calling changeStatus.

Returns boolean
true if a status change is possible, false otherwise

Implementation of UserTrait.canChangeStatus

changeStatus

changeStatus(reasonCode: ReasonCode): Promise<void>
Changes the agent's status to the specified reason

The reason must be one of the values returned from getAssignableReasonCodes.
Parameters
- reasonCode: ReasonCode
  The target ReasonCode to set
Returns Promise<void>
A promise that resolves when the status change has been applied
Throws
If the requested status and reason are already active (code ASE-0003)

Throws
If the status type is invalid (code ASE-2001)

Throws
If the reason code is not recognized (code ASE-2002)

Throws
If the status change fails (code ASE-2009)
Example
```
const reasons = await user.getAssignableReasonCodes();
const available = reasons.find(r => r.type === ReasonType.AVAILABLE);
if (available) {
  await user.changeStatus(available);
}
```
Implementation of UserTrait.changeStatus

Viewing Interactions

viewInteraction

viewInteraction(
interactionId: string,
params: ViewInteractionParams,
): Promise<Interaction>
Starts monitoring an interaction as a private or public viewer. Creates the interaction delegate, and dispatches UserEventType.INTERACTION_VIEWING_STARTED on success. Use Interaction.joinCall to join audio after viewing starts.
Parameters
- interactionId: string
  The ID of the interaction to monitor
- params: ViewInteractionParams
  ViewInteractionParams — set viewPrivately: true for silent monitoring
Returns Promise<Interaction>
Promise that resolves to the Interaction

Implementation of UserTrait.viewInteraction

getInteractionViews

getInteractionViews(): Promise<InteractionView[]>
Fetches the list of interaction views available to the current user. Views define server-side filters for the interaction list (e.g., "All Active Interactions"). Call InteractionView.getInteractions on a returned view to fetch its interactions.

Returns Promise<InteractionView[]>
A promise that resolves to an array of InteractionView
Throws
If the request fails (code ASE-2014)
Example
```
const views = await user.getInteractionViews();
const defaultView = views.find(v => v.isDefault);
if (defaultView) {
  const page = await defaultView.getInteractions({ page: 1, pageSize: 20 });
}
```
Implementation of UserTrait.getInteractionViews

canClaimInteractionOwnership

get canClaimInteractionOwnership(): boolean
Whether the agent may claim ownership of an interaction they are viewing.

Returns boolean
Whether the agent may claim ownership of a viewed interaction

Implementation of UserTrait.canClaimInteractionOwnership

canViewInteractionPublicly

get canViewInteractionPublicly(): boolean
Whether the agent may view an interaction publicly (visible to the parties).

Returns boolean
Implementation of UserTrait.canViewInteractionPublicly

canViewInteractionPrivately

get canViewInteractionPrivately(): boolean
Whether the agent may view an interaction privately (silent monitoring).

Returns boolean
Implementation of UserTrait.canViewInteractionPrivately

Class User

Typical usage flow

Index of methods and attributes

Reactivity

See

Implements

Index

CX Login

Capabilities

Events

Identity

Interactions

Media

Queues

Status Management

Viewing Interactions

CX Login

canLoginToCx

Returns boolean

loginToCx

Parameters

Returns Promise<void>

Throws

Throws

Throws

Throws

Throws

Example

Example

canLogoutFromCx

Returns boolean

logoutFromCx

Parameters

Returns Promise<void>

Throws

Example

isLoggedInToCx

Returns boolean

Capabilities

canCreateOutboundVoiceInteraction

Returns boolean

isEliteVoiceEnabled

Returns boolean

isInteractionAutoAcceptEnabled

Returns boolean

Events

subscribe

Type Parameters

Parameters

Returns string

Example

unsubscribe

Parameters

Returns void

Identity

userId

Returns string

userEmail

Returns string

userFullName

Returns string

userFirstName

Returns string

userLastName

Returns string

accountId

Returns string

Interactions

getAssignedInteractions

Returns Interaction[]

createOutboundVoiceInteraction

Parameters

OptionalqueueId?: string

phoneNumber: string

Optionalcustomer?: OutboundCustomerDetails

Optionaldetails?: AdditionalInteractionDetails

Returns Promise<Interaction>

Throws

Example

canCreateOutboundVoiceInteraction

`Optional`queueId?: string

`Optional`customer?: OutboundCustomerDetails

`Optional`details?: AdditionalInteractionDetails