WebRTC JS Client

// 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');

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

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

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

client.remoteElement = 'remoteMedia';

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

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

const client = new TelnyxRTC(options);

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

const client = new TelnyxRTC(options);
client.localElement = 'localElementMediaId';

const client = new TelnyxRTC(options);

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

const client = new TelnyxRTC(options);

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

const client = new TelnyxRTC(options);
client.remoteElement = 'remoteElementMediaId';

const client = new TelnyxRTC(options);

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

let result = await client.getAudioOutDevices();

if (result.length) {
  client.speaker = result[1].deviceId;
}

const client = new TelnyxRTC(options);

client.checkPermissions();

const client = new TelnyxRTC(options);

client.checkPermissions(true, false);

const client = new TelnyxRTC(options);

client.checkPermissions(false, true);

const client = new TelnyxRTC(options);

client.connect();

const client = new TelnyxRTC(options);

client.disableMicrophone();

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

client.disableMicrophone();

const client = new TelnyxRTC(options);

client.disableWebcam();

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

client.disableWebcam();

const client = new TelnyxRTC(options);

client.disconnect();

const client = new TelnyxRTC(options);

client.enableMicrophone();

const client = new TelnyxRTC(options);

client.enableWebcam();

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

  let result = await client.getAudioInDevices();

  console.log(result);
}

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

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

  let result = await client.getAudioOutDevices();

  console.log(result);
}

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

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

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

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

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

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

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

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

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

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

const call = client.newCall({
 destinationNumber: 'sip:example-sip-username@voip-provider.example.net'
});

const call = client.newCall({
 destinationNumber: 'telnyx-sip-username' // This is equivalent to 'sip:telnyx-sip-username@sip.telnyx.com'
});

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

client.newCall({
 destinationNumber: '18004377950',

 callerNumber: '155531234567',

 customHeaders: [ {name: "X-Header", value: "value" } ] 
});

const allCodecs = RTCRtpReceiver.getCapabilities('audio').codecs;

const PCMACodec = allCodecs.find((c) => c.mimeType.toLowerCase().includes('pcma'));

client.newCall({
 destinationNumber: 'xxx',
 preferred_codecs: [PCMACodec],
});

client.newCall({
 destinationNumber: 'xxx',
 prefetchIceCandidates: true,
});

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

const client = new TelnyxRTC(options);

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

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

const client = new TelnyxRTC(options);

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

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

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

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

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

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