WebRTC JS Client

The TelnyxRTC client connects your application to the Telnyx backend, enabling you to make outgoing calls and handle incoming calls.

The SDK can be added to your application in the following ways:

• installing it using npm from the link: https://www.npmjs.com/package/@telnyx/webrtc
• as a script in your web application using one of the external CDNs:
  • https://unpkg.com/@telnyx/webrtc
  • https://cdn.jsdelivr.net/npm/@telnyx/webrtc

// Include the Telnyx WEBRTC JS SDK
<script
    type="text/javascript"
    src="https://unpkg.com/@telnyx/[email protected]/lib/bundle.js">
</script>

// Initialize the client
const client = new TelnyxRTC({
  // Use a JWT to authenticate (recommended)
  login_token: login_token,
  // or use your Connection credentials
  //  login: username,
  //  password: password,
});

// Attach event listeners
client
  .on('telnyx.ready', () => console.log('ready to call'))
  .on('telnyx.notification', (notification) => {
    console.log('notification:', notification)
  });

// Connect and login
client.connect();

// You can call client.disconnect() when you're done.
Note: When you call `client.disconnect()` you need to remove all ON event methods you've had attached before.

// Disconnecting and Removing listeners.
client.disconnect();
client.off('telnyx.ready')
client.off('telnyx.notification');

Creates a new TelnyxRTC instance with the provided options.

NAME	TYPE	REQUIRED	DESCRIPTION
login	string	optional	The username to authenticate with your SIP Connection. login and password will take precedence over login_token for authentication.
login_token	string	required	The JSON Web Token (JWT) to authenticate with your SIP Connection. This is the recommended authentication strategy. See how to create one.
password	string	optional	The password to authenticate with your SIP Connection.
ringbackFile	string	optional	A URL to a wav/mp3 ringback file that will be used when you disable "Generate Ringback Tone" in your SIP Connection.
ringtoneFile	string	optional	A URL to a wav/mp3 ringtone file.

Authenticating with a JSON Web Token:

const client = new TelnyxRTC({
  login_token: login_token,
});

Authenticating with username and password credentials:

const client = new TelnyxRTC({
  login: username,
  password: password,
});

Custom ringback and ringtone files can be a wav/mp3 in your local public folder or a file hosted on a CDN, ex: https://cdn.company.com/sounds/call.mp3.

To use the ringbackFile, make sure the "Generate Ringback Tone" option is disabled in your Telnyx Portal connection configuration (Inbound tab.)

const client = new TelnyxRTC({
  login_token: login_token,
  ringtoneFile: './sounds/incoming_call.mp3',
  ringbackFile: './sounds/ringback_tone.mp3',
});

client.remoteElement = 'remoteMedia';

The corresponding HTML:

<audio id="remoteMedia" autoplay="true" />
// or for video:
// <video id="remoteMedia" autoplay="true" playsinline="true" />

true if the client is connected to the Telnyx RTC server

const client = new TelnyxRTC(options);
console.log(client.connected); // => false

Gets the local html element.

const client = new TelnyxRTC(options);

console.log(client.localElement);
// => HTMLMediaElement

Audio and video constraints currently used by the client.

const client = new TelnyxRTC(options);

console.log(client.mediaConstraints);
// => { audio: true, video: false }

Gets the remote html element.

const client = new TelnyxRTC(options);

console.log(client.remoteElement);
// => HTMLMediaElement

Default audio output device, if set by client.

const client = new TelnyxRTC(options);

console.log(client.speaker);
// => "abc123xyz"

Checks if the browser has the permission to access mic and/or webcam

NAME	TYPE	DEFAULT	REQUIRED	DESCRIPTION
audio	boolean	true	required	Whether to check for microphone permissions.
video	boolean	true	required	Whether to check for webcam permissions.

Checking for audio and video permissions:

const client = new TelnyxRTC(options);

client.checkPermissions();

Checking only for audio permissions:

const client = new TelnyxRTC(options);

client.checkPermissions(true, false);

Checking only for video permissions:

const client = new TelnyxRTC(options);

client.checkPermissions(false, true);

Creates a new connection for exchanging data with the WebRTC server

const client = new TelnyxRTC(options);

client.connect();

Disables use of the microphone in subsequent calls.

Note: This setting will be ignored if audio: true is specified when creating a new call.

const client = new TelnyxRTC(options);

client.disableMicrophone();

Keep in mind that new calls will fail if both the microphone and webcam is disabled. Make sure that the webcam is manually enabled, or video: true is specified before disabling the microphone.

const client = new TelnyxRTC({
  ...options,
  video: true
});

client.disableMicrophone();

Disables use of the webcam in subsequent calls.

Note: This method will disable the video even if video: true is specified.

const client = new TelnyxRTC(options);

client.disableWebcam();

const client = new TelnyxRTC({
  ...options,
  video: true
});

client.disableWebcam();

Disconnect all active calls

const client = new TelnyxRTC(options);

client.disconnect();

Enables use of the microphone in subsequent calls.

Note: This setting will be ignored if audio: false is specified when creating a new call.

const client = new TelnyxRTC(options);

client.enableMicrophone();

Enables use of the webcam in subsequent calls.

Note: This setting will be ignored if video: false is specified when creating a new call.

const client = new TelnyxRTC(options);

client.enableWebcam();

Returns the audio input devices supported by the browser.

Using async/await:

async function() {
  const client = new TelnyxRTC(options);

  let result = await client.getAudioInDevices();

  console.log(result);
}

Using ES6 Promises:

client.getAudioInDevices().then((result) => {
  console.log(result);
});

Returns the audio output devices supported by the browser.

Browser Compatibility Note: Firefox has yet to fully implement audio output devices. As of v63, this feature is behind the user preference media.setsinkid.enabled. See: https://bugzilla.mozilla.org/show_bug.cgi?id=1152401#c98

Using async/await:

async function() {
  const client = new TelnyxRTC(options);

  let result = await client.getAudioOutDevices();

  console.log(result);
}

Using ES6 Promises:

client.getAudioOutDevices().then((result) => {
  console.log(result);
});

Returns supported resolution for the given webcam.

NAME	TYPE	REQUIRED	DESCRIPTION
deviceId	string	required	the deviceId from your webcam.

If deviceId is null

1. if deviceId is null and you don't have a webcam connected to your computer, it will throw an error with the message "Requested device not found".

2. if deviceId is null and you have one or more webcam connected to your computer, it will return a list of resolutions from the default device set up in your operating system.

Using async/await:

async function() {
  const client = new TelnyxRTC(options);
  let result = await client.getDeviceResolutions();
  console.log(result);
}

Using ES6 Promises:

client.getDeviceResolutions().then((result) => {
  console.log(result);
});

If deviceId is not null

it will return a list of resolutions from the deviceId sent.

Using async/await:

async function() {
  const client = new TelnyxRTC(options);
  let result = await client.getDeviceResolutions(deviceId);
  console.log(result);
}

Using ES6 Promises:

client.getDeviceResolutions(deviceId).then((result) => {
  console.log(result);
});

Returns a list of devices supported by the browser

Using async/await:

async function() {
  const client = new TelnyxRTC(options);
  let result = await client.getDevices();
  console.log(result);
}

Using ES6 Promises:

client.getDevices().then((result) => {
  console.log(result);
});

Returns a list of video devices supported by the browser (i.e. webcam).

Using async/await:

async function() {
  const client = new TelnyxRTC(options);
  let result = await client.getVideoDevices();
  console.log(result);
}

Using ES6 Promises:

client.getVideoDevices().then((result) => {
  console.log(result);
});

Alias for .disconnect()

Makes a new outbound call.

NAME	TYPE	REQUIRED	DESCRIPTION
audio	boolean	optional	Overrides client's default audio constraints. Defaults to true
callerName	string	optional	Name to use as the caller ID name when dialing out to a destination.
callerNumber	string	optional	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.
camId	string	optional	deviceId to use as webcam. Overrides the client's default one.
clientState	string	optional	Telnyx's Call Control client_state. Can be used with Connections with Advanced Events enabled. clientState string should be base64 encoded.
destinationNumber	string	required	Phone number or SIP URI to dial.
iceServers	RTCIceServer[]	optional	Overrides client's default iceServers.
id	string	optional	Custom ID to identify the call. This will be used as the callID in place of the UUID generated by the client.
localElement	string | HTMLMediaElement	optional	Overrides client's default localElement.
localStream	MediaStream	optional	If set, the call will use this stream instead of retrieving a new one.
mediaSettings	undefined	required	Configures media (audio/video) in a call.
micId	string	optional	deviceId to use as microphone. Overrides the client's default one.
onNotification	Function	optional	Overrides client's default telnyx.notification handler for this call.
remoteElement	string | HTMLMediaElement	optional	Overrides client's default remoteElement.
remoteStream	MediaStream	optional	If set, the call will use this stream instead of retrieving a new one.
speakerId	string	optional	deviceId to use as speaker. Overrides the client's default one.
telnyxCallControlId	string	optional	Telnyx Call Control ID, if using Call Control services.
telnyxLegId	string	optional	Telnyx call leg ID, if using Call Control services.
telnyxSessionId	string	optional	Telnyx call session ID, if using Call Control services.
useStereo	boolean	optional	Uses stereo audio instead of mono.
video	boolean	optional	Overrides client's default video constraints. Defaults to false
deviceId	string	optional

Making an outbound call to +1 856-444-0362 using default values from the client:

const call = client.newCall({
  destinationNumber: '+18564440362',
  callerNumber: '+15551231234'
});

You can omit callerNumber when dialing a SIP address:

const call = client.newCall({
 destinationNumber: 'sip:[email protected]'
});

If you are making calls from one Telnyx connection to another, you may specify just the SIP username:

const call = client.newCall({
 destinationNumber: 'telnyx-sip-username' // This is equivalent to 'sip:[email protected]'
});

An error will be thrown if destinationNumber is not specified.

const call = client.newCall().catch(console.error);
// => `destinationNumber is required`

Removes an event handler that were attached with .on(). If no handler parameter is passed, all listeners for that event will be removed.

NAME	TYPE	REQUIRED	DESCRIPTION
eventName	string	required	Event name.
callback	Function	optional	Function handler to be removed.

Subscribe to the telnyx.error and then, remove the event handler.

const errorHandler = (error) => {
 // Log the error..
}

const client = new TelnyxRTC(options);

client.on('telnyx.error', errorHandler)

 // .. later
client.off('telnyx.error', errorHandler)

Attaches an event handler for a specific type of event.

telnyx.ready	The client is authenticated and available to use
telnyx.error	An error occurred at the session level
telnyx.notification	An update to the call or session
telnyx.socket.open	The WebSocket connection has been made
telnyx.socket.close	The WebSocket connection is set to close
telnyx.socket.error	An error occurred at the WebSocket level
telnyx.socket.message	The client has received a message through WebSockets

NAME	TYPE	REQUIRED	DESCRIPTION
eventName	string	required	Event name.
callback	Function	required	Function to call when the event comes.

Subscribe to the telnyx.ready and telnyx.error events.

const client = new TelnyxRTC(options);

client.on('telnyx.ready', (client) => {
  // Your client is ready!
}).on('telnyx.error', (error) => {
  // Got an error...
})

Sets the default audio constraints for your client. See here for further details.

Note: It's a common behaviour, in WebRTC applications, to persist devices user's selection to then reuse them across visits. Due to a Webkit’s security protocols, Safari generates random deviceId on each page load. To avoid this issue you can specify two additional properties micId and micLabel in the constraints input parameter. The client will use these values to assure the microphone you want to use is available by matching both id and label with the device list retrieved from the browser.

NAME	TYPE	REQUIRED	DESCRIPTION
settings	IAudioSettings	required	(https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints) object with the addition of micId and micLabel.

Set microphone by id and label with the echoCancellation flag turned off:

// within an async function
const constraints = await client.setAudioSettings({
 micId: '772e94959e12e589b1cc71133d32edf543d3315cfd1d0a4076a60601d4ff4df8',
 micLabel: 'Internal Microphone (Built-in)',
 echoCancellation: false
})

Sets the default video constraints for your client. See here for further details.

Note: It's a common behaviour, in WebRTC applications, to persist devices user's selection to then reuse them across visits. Due to a Webkit’s security protocols, Safari generates random deviceId on each page load. To avoid this issue you can specify two additional properties camId and camLabel in the constraints input parameter. The client will use these values to assure the webcam you want to use is available by matching both id and label with the device list retrieved from the browser.

NAME	TYPE	REQUIRED	DESCRIPTION
settings	IVideoSettings	required	(https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints) object with the addition of camId and camLabel.

Set webcam by id and label with 720p resolution.

// within an async function
const constraints = await client.setVideoSettings({
 camId: '882e94959e12e589b1cc71133d32edf543d3315cfd1d0a4076a60601d4ff4df8',
 camLabel: 'Default WebCam (Built-in)',
 width: 1080,
 height: 720
})

Checks if the running browser has support for TelnyRTC

Check if your browser supports TelnyxRTC

const info = TelnyxRTC.webRTCInfo();
const isWebRTCSupported = info.supportWebRTC;
console.log(isWebRTCSupported); // => true

An error message will be returned if your browser doesn't support TelnyxRTC

const info = TelnyxRTC.webRTCInfo();
if (!info.supportWebRTC) {
  console.error(info) // => 'This browser does not support @telnyx/webrtc. To see browser support list: `TelnyxRTC.webRTCSupportedBrowserList()'
}

Returns the WebRTC supported browser list.

The following table indicates the browsers supported by TelnyxRTC. We support the most recent (N) versions of these browsers unless otherwise indicated.

	CHROME	FIREFOX	SAFARI	EDGE
Android	-	-
iOS			x
Linux	x	-
MacOS	x	-	x	-
Windows	x	-		-

x supports audio and video - supports only audio not supported

const browserList = TelnyxRTC.webRTCSupportedBrowserList();
console.log(browserList) // => [{"operationSystem": "Android", "supported": [{"browserName": "Chrome", "features": ["video", "audio"], "supported": "full"},{...}]