Interface IClientOptions

IClientOptions IClientOptions

Hierarchy

  • IClientOptions

Properties

anonymous_login? debug? debugOutput? forceRelayCandidate? keepConnectionAliveOnSocketClose? login? login_token? password? prefetchIceCandidates? region? ringbackFile? ringtoneFile? rtcIp? rtcPort? trickleIce?

Properties

Optional anonymous_login

anonymous_login?: {
    target_id: string;
    target_type: string;
    target_version_id?: string;
}

anonymous_login login options

Type declaration

  • target_id: string

    The target ID to use for the anonymous login. this is typically the ID of the AI assistant you want to connect to.

  • target_type: string

    A string indicating the target type, for now only ai_assistant is supported.

  • Optional target_version_id?: string

    The target version ID to use for the anonymous login. This is optional and can be used to specify a particular version of the AI assistant.

Optional debug

debug?: boolean

Enable debug mode for this client. This will gather WebRTC debugging information.

Optional debugOutput

debugOutput?: "file" | "socket"

Debug output option

Optional forceRelayCandidate

forceRelayCandidate?: boolean

Force the use of a relay ICE candidate.

Optional keepConnectionAliveOnSocketClose

keepConnectionAliveOnSocketClose?: boolean

Keep the connection alive on socket connection close, i.e., do not hang up the call when attach message is received.

Optional login

login?: string

The username to authenticate with your SIP Connection. login and password will take precedence over login_token for authentication.

Optional login_token

login_token?: string

The JSON Web Token (JWT) to authenticate with your SIP Connection. This is the recommended authentication strategy. See how to create one.

Optional password

password?: string

The password to authenticate with your SIP Connection.

Optional prefetchIceCandidates

prefetchIceCandidates?: boolean

Enable or disable prefetching ICE candidates.

Optional region

region?: string

Region to use for the connection.

Optional ringbackFile

ringbackFile?: string

A URL to a wav/mp3 ringback file that will be used when you disable "Generate Ringback Tone" in your SIP Connection.

Optional ringtoneFile

ringtoneFile?: string

A URL to a wav/mp3 ringtone file.

Optional rtcIp

rtcIp?: string

RTC connection IP address to use instead of the default one. Useful when using a custom signaling server.

Optional rtcPort

rtcPort?: number

RTC connection port to use instead of the default one. Useful when using a custom signaling server.

Optional trickleIce

trickleIce?: boolean

Enable or disable Trickle ICE.

Settings

Member Visibility

Theme

On This Page