@jambonz/sdk
    Preparing search index...

    Interface CreateCallRequest

    interface CreateCallRequest {
        application_sid?: string;
        call_hook?: ActionHook;
        call_status_hook?: ActionHook;
        from: string;
        to: {
            type: "phone" | "sip" | "user" | "teams";
            number?: string;
            sipUri?: string;
            name?: string;
            tenant?: string;
        };
        answerOnBridge?: boolean;
        trunk?: string;
        fromHost?: string;
        headers?: Record<string, string>;
        tag?: Record<string, unknown>;
        timeout?: number;
        timeLimit?: number;
        sipRequestWithinDialogHook?: ActionHook;
        speech_synthesis_vendor?: string;
        speech_synthesis_language?: string;
        speech_synthesis_voice?: string;
        speech_recognizer_vendor?: string;
        speech_recognizer_language?: string;
        amd?: Record<string, unknown>;
    }
    Index

    Properties

    application_sid? call_hook? call_status_hook? from to answerOnBridge? trunk? fromHost? headers? tag? timeout? timeLimit? sipRequestWithinDialogHook? speech_synthesis_vendor? speech_synthesis_language? speech_synthesis_voice? speech_recognizer_vendor? speech_recognizer_language? amd?

    Properties

    application_sid?: string

    Application SID to handle the call.

    call_hook?: ActionHook

    Webhook URL for the call.

    call_status_hook?: ActionHook

    Status callback URL.

    from: string

    Caller ID.

    to: {
        type: "phone" | "sip" | "user" | "teams";
        number?: string;
        sipUri?: string;
        name?: string;
        tenant?: string;
    }

    Destination number or SIP URI.

    answerOnBridge?: boolean

    Ring until outbound call answers before sending 200 OK.

    trunk?: string

    SIP trunk to use.

    fromHost?: string

    Hostname for SIP From header.

    headers?: Record<string, string>

    Custom SIP headers.

    tag?: Record<string, unknown>

    Tag metadata.

    timeout?: number

    Seconds to wait for answer (default: 60).

    timeLimit?: number

    Maximum call duration in seconds.

    sipRequestWithinDialogHook?: ActionHook

    Webhook for SIP requests within the dialog.

    speech_synthesis_vendor?: string

    TTS vendor (required when not using application_sid).

    speech_synthesis_language?: string

    TTS language.

    speech_synthesis_voice?: string

    TTS voice.

    speech_recognizer_vendor?: string

    STT vendor (required when not using application_sid).

    speech_recognizer_language?: string

    STT language.

    amd?: Record<string, unknown>

    Answering machine detection settings.

    Settings

    Member Visibility

    On This Page

    Properties