Table of contents
Properties
- anonymous_login
- debug
- debugOutput
- forceRelayCandidate
- login
- login_token
- password
- prefetchIceCandidates
- region
- ringbackFile
- ringtoneFile
Properties
anonymous_login
•Optional anonymous_login: Object
anonymous_login login options
Type declaration
| Name | Type | Description |
|---|---|---|
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. |
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. |
debug
•Optional debug: boolean
Enable debug mode for this client.
This will gather WebRTC debugging information.
debugOutput
•Optional debugOutput: "file" | "socket"
Debug output option
forceRelayCandidate
•Optional forceRelayCandidate: boolean
Force the use of a relay ICE candidate.
login
•Optional login: string
The username to authenticate with your SIP Connection.
login and password will take precedence over
login_token for authentication.
login_token
•Optional 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.
password
•Optional password: string
The password to authenticate with your SIP Connection.
prefetchIceCandidates
•Optional prefetchIceCandidates: boolean
Enable or disable prefetching ICE candidates.
region
•Optional region: string
Region to use for the connection.
ringbackFile
•Optional ringbackFile: string
A URL to a wav/mp3 ringback file that will be used when you disable
“Generate Ringback Tone” in your SIP Connection.
ringtoneFile
•Optional ringtoneFile: string
A URL to a wav/mp3 ringtone file.