Member Junction
    Preparing search index...

    Telephony bridge driver for OpenAI Direct SIP telephony (detached media plane).

    Inbound only — OpenAI terminates the live SIP call; MemberJunction attaches a sideband connection to observe telemetry, handle tool calls, and receive DTMF notifications.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    agentNumber: string
    botParticipantId: string
    callEndedHandlers: (() => void)[]
    callerNumber: string
    dtmfHandlers: ((digit: string) => void)[]
    externalCallId: string

    The capability flags for the provider this bridge instance serves. Populated from the RealtimeBridgeContext at BaseRealtimeBridge.Connect time (and may be set by the engine immediately after construction). Drives BaseRealtimeBridge.RequireFeature.

    mediaHandlers: ((frame: BridgeMediaFrame) => void)[]
    providerName: string

    The provider's display name for this bridge instance, used in capability-error messages. Populated from the RealtimeBridgeContext; falls back to the driver class name.

    Accessors

    Methods

    • Fires call-ended handlers when the call terminates.

      Returns void

    • Dispatches an inbound DTMF digit to registered listeners.

      Parameters

      • digit: string

      Returns void

    • No-op on a detached media plane: MJ holds no outbound audio queue to flush.

      Returns void

    • Registers a handler invoked when the driver can no longer show the agent's avatar (see BridgeAvatarFailure): it has taken the avatar's video down and told the room. The engine then replaces the model session with one that renders no avatar, so the model stops generating (and billing) video nobody sees.

      No-op by default (NOT capability-gated): a driver that publishes no avatar never loses one, so registering is always safe. Drivers that publish an agent's avatar override it.

      Parameters

      • _handler: (reason: BridgeAvatarFailure) => void

        Invoked once, with why the avatar can no longer be shown.

      Returns void

    • Registers a callback fired when the call has ended.

      Parameters

      • handler: () => void

      Returns void

    • Registers a handler for received DTMF digits (receive-only).

      Parameters

      • handler: (digit: string) => void

      Returns void

    • Registers an observer for inbound media frames (if the provider reflects copies of audio on the sideband).

      Parameters

      Returns void

    • Registers a handler invoked when the endpoint's roster changes (join / leave / role change).

      Capability-gated by SupportedFeatures.SpeakerDiarization. Throws unless overridden.

      Parameters

      • _handler: (participants: BridgeParticipantInfo[]) => void

        Invoked with the updated participant list on each change.

      Returns void

      when not overridden.

    • Registers a handler invoked when an inbound camera or screen source the driver was sending stops: the person stopped letting agents see them, left, stopped sharing or turned the camera off, or the driver moved the model's view to another source. The engine tells the model, so it stops describing what it can no longer see.

      No-op by default (NOT capability-gated): a driver that sends no inbound video has no source to end, so registering is always safe. Drivers that send camera or screen frames override it.

      Parameters

      Returns void

    • Sends DTMF tones on a telephony bridge.

      Capability-gated by SupportedFeatures.DTMF. Throws unless overridden by a telephony driver.

      Parameters

      • _digits: string

        The DTMF digit string to send (e.g. '1234#').

      Returns Promise<void>

      A promise that resolves once the tones have been sent.

      when not overridden.

    • Requests that the platform begin recording the session.

      Capability-gated by SupportedFeatures.Recording (and subject to per-jurisdiction consent handling upstream). Throws unless overridden.

      Returns Promise<void>

      A promise that resolves once recording has started.

      when not overridden.