edgeport - v1.0.3
    Preparing search index...

    Interface SipConnectOptions

    Options for connect.

    1.0.3

    interface SipConnectOptions {
        authUsername?: string;
        displayName?: string;
        domain?: string;
        expiresSeconds?: number;
        hostname: string;
        instanceId?: string;
        password?: string;
        port?: number;
        scheduler?: SipScheduler;
        timeoutMs?: number;
        tls?: "off" | "implicit";
        username: string;
    }
    Index
    authUsername? displayName? domain? expiresSeconds? hostname instanceId? password? port? scheduler? timeoutMs? tls? username
    authUsername?: string

    Auth username, if different from username.

    displayName?: string

    Optional display name for the From header.

    domain?: string

    The SIP domain / realm host; defaults to hostname. Used to build the AOR.

    expiresSeconds?: number

    Default registration expiry in seconds; defaults to 3600.

    hostname: string

    SIP server / registrar host to dial (also the TLS certificate identity).

    instanceId?: string

    RFC 5626 instance id (a URN); generated when omitted.

    password?: string

    The account password (omit for a server that does not challenge).

    port?: number

    TCP port; defaults to 5060 (plaintext) or 5061 (tls: 'implicit').

    scheduler?: SipScheduler

    Timer override for refresh/keep-alive (mainly for testing).

    timeoutMs?: number

    Per-request read deadline in milliseconds.

    tls?: "off" | "implicit"

    Transport security: 'off' (default) plaintext, or 'implicit' TLS (SIPS).

    username: string

    The account user part (the AOR user, e.g. alice in sip:alice@domain).

    Settings
    Member Visibility

    On This Page
    Properties