@jambonz/sdk
    Preparing search index...

    Interface DialVerb

    interface DialVerb {
        verb: "dial";
        id?: string;
        target: Target[];
        actionHook?: ActionHook;
        onHoldHook?: ActionHook;
        answerOnBridge?: boolean;
        callerId?: string;
        callerName?: string;
        confirmHook?: ActionHook;
        referHook?: ActionHook;
        dialMusic?: string;
        dtmfCapture?: Record<string, unknown>;
        dtmfHook?: ActionHook;
        headers?: Record<string, string>;
        anchorMedia?: boolean;
        exitMediaPath?: boolean;
        boostAudioSignal?: string | number;
        listen?: Omit<ListenVerb, "verb">;
        stream?: Omit<StreamVerb, "verb">;
        transcribe?: Omit<TranscribeVerb, "verb">;
        timeLimit?: number;
        timeout?: number;
        proxy?: string;
        amd?: Amd;
        dub?: Omit<DubVerb, "verb">[];
        tag?: Record<string, unknown>;
        forwardPAI?: boolean;
    }
    Index

    Properties

    verb id? target actionHook? onHoldHook? answerOnBridge? callerId? callerName? confirmHook? referHook? dialMusic? dtmfCapture? dtmfHook? headers? anchorMedia? exitMediaPath? boostAudioSignal? listen? stream? transcribe? timeLimit? timeout? proxy? amd? dub? tag? forwardPAI?

    Properties

    verb: "dial"
    id?: string
    target: Target[]

    Call targets (simultaneous ring).

    actionHook?: ActionHook

    Webhook when dialed call ends.

    onHoldHook?: ActionHook

    Webhook when call is placed on hold.

    answerOnBridge?: boolean

    Delay answering inbound until outbound answers.

    callerId?: string

    Caller ID for outbound call.

    callerName?: string

    Caller display name.

    confirmHook?: ActionHook

    Webhook for call screening.

    referHook?: ActionHook

    Webhook for SIP REFER on bridged call.

    dialMusic?: string

    Audio URL for ringback tone replacement.

    dtmfCapture?: Record<string, unknown>

    DTMF capture patterns during bridged call.

    dtmfHook?: ActionHook

    Webhook for captured DTMF patterns.

    headers?: Record<string, string>

    Custom SIP headers on outbound INVITE.

    anchorMedia?: boolean

    Keep media through jambonz media server.

    exitMediaPath?: boolean

    Remove jambonz from media path after bridge.

    boostAudioSignal?: string | number

    Audio signal boost/attenuation in dB.

    listen?: Omit<ListenVerb, "verb">

    Audio streaming config for bridged call.

    stream?: Omit<StreamVerb, "verb">

    Audio streaming config (alias for listen).

    transcribe?: Omit<TranscribeVerb, "verb">

    Transcription config for bridged call.

    timeLimit?: number

    Max bridged call duration in seconds.

    timeout?: number

    Seconds to wait for answer.

    proxy?: string

    SIP proxy for outbound call.

    amd?: Amd

    Answering machine detection config.

    dub?: Omit<DubVerb, "verb">[]

    Audio dubbing tracks.

    tag?: Record<string, unknown>

    Metadata for this call leg.

    forwardPAI?: boolean

    Forward P-Asserted-Identity header.

    Settings

    Member Visibility

    On This Page

    Properties