Acrobits IPC SDK
    Preparing search index...

    Interface CallInfoItem

    Represents information about a single call.

    interface CallInfoItem {
        callId: string;
        callState: CallState;
        establishedDate?: number;
        eventId: number;
        groupId?: string;
        isHeld: boolean;
        localHeld?: boolean;
        remoteHeld?: boolean;
        remoteUser: RemoteUser;
    }
    Index

    Properties

    callId callState establishedDate? eventId groupId? isHeld localHeld? remoteHeld? remoteUser

    Properties

    callId: string

    Unique identifier for the call.

    callState: CallState

    Current state of the call.

    establishedDate?: number

    Optional timestamp (in seconds since epoch) when the call was established.

    eventId: number

    Call event ID as tracked by the Host app.

    groupId?: string

    Optional group ID as tracked by the Host app, provided if the call is part of a group.

    isHeld: boolean

    Legacy aggregate indicator that the call is currently on hold.

    Use CallInfoItem.localHeld to decide whether a local Hold or Unhold action is appropriate, and CallInfoItem.remoteHeld for remote-hold presentation. This property remains available for hosts that do not provide directional hold state.

    localHeld?: boolean

    Whether this endpoint has placed the call on hold.

    Optional for compatibility with hosts that predate directional hold reporting.

    remoteHeld?: boolean

    Whether the remote endpoint has placed the call on hold.

    Optional for compatibility with hosts that predate directional hold reporting.

    remoteUser: RemoteUser

    Information about the remote user in the call.

    Settings

    Member Visibility

    On This Page

    Properties