Member Junction
    Preparing search index...

    Interface RoomCallStartArgs

    One agent session to start in a room.

    interface RoomCallStartArgs {
        Agent: { AgentID: string; Name?: string };
        CallerLabel?: string;
        Channel: "phone" | "web";
        ContextUser: UserInfo;
        ConversationID?: string;
        DialedNumber?: string;
        Direction: "Inbound" | "Outbound";
        HangUp?: () => Promise<void>;
        Lease?: CallCapacityLease | null;
        MetadataProvider: IMetadataProvider;
        OnEnded?: (reason: BridgeDisconnectReason) => void;
        RealtimeModelID?: string;
        RealtimeVoice?: string;
        RemoteNumber?: string;
        RoomName: string;
        Takeover?: { Brief: string; PreviousAgentName: string };
    }
    Index

    Properties

    Agent CallerLabel? Channel ContextUser ConversationID? DialedNumber? Direction HangUp? Lease? MetadataProvider OnEnded? RealtimeModelID? RealtimeVoice? RemoteNumber? RoomName Takeover?

    Properties

    Agent: { AgentID: string; Name?: string }

    The agent the caller talks to (the persona). The voice front-end that speaks as it is resolved by the starter.

    CallerLabel?: string

    Who is on the other end, in words a person can use. Defaults to a masked number (phone) or Web visitor.

    Channel: "phone" | "web"

    phone for a call that went through SIP; web for a person in the room from a browser.

    ContextUser: UserInfo
    ConversationID?: string

    Reuse an existing conversation (a taking-over agent continues the call's record).

    DialedNumber?: string

    The number that was dialled (inbound), for the caller-identity hook.

    Direction: "Inbound" | "Outbound"
    HangUp?: () => Promise<void>

    Hangs up the phone leg(s) of the call. Called when the agent ends the call; absent for a web room.

    Lease?: CallCapacityLease | null

    The capacity slot this agent already holds; the starter owns releasing it.

    MetadataProvider: IMetadataProvider
    OnEnded?: (reason: BridgeDisconnectReason) => void

    Called once when this agent's session has ended, for the caller's own bookkeeping.

    RealtimeModelID?: string
    RealtimeVoice?: string
    RemoteNumber?: string

    The phone party's number: the caller (inbound) or the number being dialled (outbound).

    RoomName: string
    Takeover?: { Brief: string; PreviousAgentName: string }

    Set when this agent takes a conversation over from another.

    Settings

    Member Visibility

    On This Page

    Properties