WebRTC JS Call Options

ICallOptions ICallOptions

• audio
• callerName
• callerNumber
• camId
• clientState
• customHeaders
• debug
• debugOutput
• destinationNumber
• forceRelayCandidate
• iceServers
• id
• localElement
• localStream
• mediaSettings
• micId
• onNotification
• preferred_codecs
• prefetchIceCandidates
• remoteElement
• remoteStream
• speakerId
• telnyxCallControlId
• telnyxLegId
• telnyxSessionId
• useStereo
• video

• Optional audio: boolean

Overrides client's default audio constraints. Defaults to true

---

• Optional callerName: string

Name to use as the caller ID name when dialing out to a destination.

---

• Optional callerNumber: string

Number to use as the caller ID when dialing out to a destination. A valid phone number is required for dials out to PSTN numbers.

---

• Optional camId: string

deviceId to use as webcam. Overrides the client's default one.

---

• Optional clientState: string

Telnyx's Call Control client_state. Can be used with Connections with Advanced -> Events enabled. clientState string should be base64 encoded.

---

• Optional customHeaders: { name: string ; value: string }[]

Add custom headers to the INVITE and ANSWER request.

---

• Optional debug: boolean

Enable debug mode for this call.

---

• Optional debugOutput: "file" | "socket"

Output debug logs to a file.

---

• destinationNumber: string

Phone number or SIP URI to dial.

---

• Optional forceRelayCandidate: boolean

Force the use of a relay ICE candidate.

---

• Optional iceServers: RTCIceServer[]

Overrides client's default iceServers.

---

• Optional id: string

Custom ID to identify the call. This will be used as the callID in place of the UUID generated by the client.

---

• Optional localElement: string | HTMLMediaElement

Overrides client's default localElement.

---

• Optional localStream: MediaStream

If set, the call will use this stream instead of retrieving a new one.

---

• Optional mediaSettings: Object

Configures media (audio/video) in a call.

Name	Type
sdpASBandwidthKbps?	number
useSdpASBandwidthKbps?	boolean

---

• Optional micId: string

deviceId to use as microphone. Overrides the client's default one.

---

• Optional onNotification: Function

Overrides client's default telnyx.notification handler for this call.

---

• Optional preferred_codecs: RTCRtpCodecCapability[]

Preferred codecs for the call.

---

• Optional prefetchIceCandidates: boolean

Enable or disable ICE Candidate Prefetching.

---

• Optional remoteElement: string | HTMLMediaElement

Overrides client's default remoteElement.

---

• Optional remoteStream: MediaStream

If set, the call will use this stream instead of retrieving a new one.

---

• Optional speakerId: string

deviceId to use as speaker. Overrides the client's default one.

---

• Optional telnyxCallControlId: string

Telnyx Call Control ID, if using Call Control services.

---

• Optional telnyxLegId: string

Telnyx call leg ID, if using Call Control services.

---

• Optional telnyxSessionId: string

Telnyx call session ID, if using Call Control services.

---

• Optional useStereo: boolean

Uses stereo audio instead of mono.

---

• Optional video: boolean

Overrides client's default video constraints. Defaults to false