LiveKit JS Server SDK - v2.14.2
    Preparing search index...

    Interface CreateSipParticipantOptions

    interface CreateSipParticipantOptions {
        displayName?: string;
        dtmf?: string;
        fromNumber?: string;
        headers?: { [key: string]: string };
        hidePhoneNumber?: boolean;
        includeHeaders?: SIPHeaderOptions;
        krispEnabled?: boolean;
        maxCallDuration?: number;
        participantAttributes?: { [key: string]: string };
        participantIdentity?: string;
        participantMetadata?: string;
        participantName?: string;
        playDialtone?: boolean;
        playRingtone?: boolean;
        ringingTimeout?: number;
        timeout?: number;
        waitUntilAnswered?: boolean;
    }
    Index

    Properties

    displayName? dtmf? fromNumber? headers? hidePhoneNumber? includeHeaders? krispEnabled? maxCallDuration? participantAttributes? participantIdentity? participantMetadata? participantName? playDialtone? playRingtone? ringingTimeout? timeout? waitUntilAnswered?

    Properties

    displayName?: string

    Optional display name for the SIP participant

    dtmf?: string

    Optionally send following DTMF digits (extension codes) when making a call. Character 'w' can be used to add a 0.5 sec delay.

    fromNumber?: string

    Optional SIP From number to use. If empty, trunk number is used.

    headers?: { [key: string]: string }

    These headers are sent as-is and may help identify this call as coming from LiveKit for the other SIP endpoint.

    hidePhoneNumber?: boolean
    includeHeaders?: SIPHeaderOptions

    Map SIP response headers from INVITE to sip.h.* participant attributes automatically.

    krispEnabled?: boolean

    If true, Krisp noise cancellation will be enabled for the caller.

    maxCallDuration?: number

    Maximum call duration in seconds.

    participantAttributes?: { [key: string]: string }

    Optional attributes to attach to the participant

    participantIdentity?: string

    Optional identity of the SIP participant

    participantMetadata?: string

    Optional metadata to attach to the participant

    participantName?: string

    Optional name of the participant

    playDialtone?: boolean

    If true, the SIP Participant plays a dial tone to the room until the phone is picked up.

    playRingtone?: boolean

    use playDialtone instead

    ringingTimeout?: number

    Maximum time for the call to ring in seconds.

    timeout?: number

    Optional request timeout in seconds. default 60 seconds if waitUntilAnswered is true, otherwise 10 seconds

    waitUntilAnswered?: boolean

    If true, this will wait until the call is answered before returning.

    Settings

    Member Visibility

    On This Page

    Properties