Voice JavaScript SDK: Twilio.Device

The Device object is available when the JavaScript SDK is included in your application. It represents a softphone that communicates with Twilio to facilitate inbound and outbound audio connections.

For the full API reference, view the autogenerated documentation on GitHub.

Table of Contents

• Instantiate a Device
• DeviceOptions
• Methods
• Events
• Accessors
• Static Methods
• Static Properties
• Static Accessors

Instantiate a Device

A new instance of a Device should be constructed by using the new keyword and passing an Access Token as the first argument. The constructor also takes an optional second argument, DeviceOptions.

No signaling channel will be opened when instantiating a new Device. The signaling WebSocket will be opened when either device.register() or device.connect() are called.

Instantiate a Device without DeviceOptions

const device = new Device(token);

The DeviceOptions parameter is optional. The Device instance's options can be updated after instantiation using the device.updateOptions() method.

Instantiate a Device with DeviceOptions

Examples of using DeviceOptions to specify an Edge location:

// Instantiate the device with a specified edge location
const device = new Device(token, { edge: 'ashburn'};

// Instantiate the device with a specified edge and auto-fallback functionality
const device = new Device(token, { edge: ['ashburn', 'sydney'] };

To see all of the possible properties, see the DeviceOptions section below.

DeviceOptions

The Device instance can be configured using the DeviceOptions parameter in two ways: during instantiation with the new keyword or by calling device.updateOptions().

const deviceOptions = {
  edge: 'ashburn', 
}

// pass the options object as the second argument in Device constructor
const device = new Device(token, deviceOptions);

// or

// use the updateOptions method after instantiating the device
const device = new Device(token);
device.updateOptions(deviceOptions);

DeviceOptions is a JavaScript object with the properties listed in the table below. All properties are optional.

Example:

Specify an Edge location using DeviceOptions

// pass options object during device instantiation
const device = new Device(token, { edge: 'ashburn' });

// or

// pass options object using the updateOptions method
const device = new Device(token);
device.updateOptions({ edge: 'ashburn' });

Example:

Specify an Edge location and custom sounds

const deviceOptions = {
  edge: 'ashburn', 
  sounds: {
    incoming: 'http://mysite.com/incoming.mp3',
    outgoing: 'http://mysite.com/outgoing.mp3', 
    dtmf8: 'http://mysite.com/8_button.mp3'
  }
}


// pass options object during device instantiation
const device = new Device(token, deviceOptions);

// or

// pass options object using the updateOptions method
const device = new Device(token);
device.updateOptions(deviceOptions);

deviceOptions.sounds properties and default sounds

The available properties on the deviceOptions.sounds object are listed in the left column of the table below. In the right column, there are audio players to hear the default sounds provided by the Voice JavaScript SDK.

Methods

This section contains descriptions of the methods available on a Device instance.

device.addListener(eventName, listener)

Add an event listener to the Device instance. This is an alias for device.on().

See the Events section of this page to see the full list of events emitted by a Device instance.

Example:

If you want to know when your Device instance is ready to receive incoming calls, listen for the 'registered' event.

const device = new Device(token);

device.addListener('registered', device => {
  console.log('The device is ready to receive incoming calls.')
});

See the Node.js Events Docs for more information.

device.connect(ConnectOptions)

Attempts a new connection to the Twilio application that you associated with the Access Token used when instantiating the Device instance.

This method will return a Promise with a Call object. You should keep track of this Call object to monitor/modify the active call.

To end the call, you can use the .disconnect() method on the Call object or use the device.disconnectAll() method.

const device = new Device(token);

let call = await device.connect({ 
  params: {
    To: '+15551234567'
  } 
});

ConnectOptions

device.connect() takes an optional ConnectOptions argument. The ConnectOptions object is a JavaScript object with optional params, rtcConfiguration, and rtcConstraints properties.

Example:

const device = new Device(token);

let call = await device.connect({
  params: {
    To: "+15551234567"
    agent: "Smith",
    location: "Matrix"
  },
  rtcConstraints: {
    audio: true
  },
  rtcConfiguration: {
    iceServers: [{
      urls: "stunserver.example.com",
      username: "username@twilio.com",
      credential: "webrtcCredential"
    }]
  }
})

params property

A JavaScript object containing key/value pairs to be sent to the Twilio application. These params will be passed to your application as GET or POST parameters.

For example, the following code will pass the params key/value pairs agent=Smith and location=Matrix to the Twilio application associated with this Device instance's Access Token.

const device = new Device(token);

let call = await device.connect({
  params: {
    agent: "Smith", 
    location: "Matrix"
  }
});

rtcConfiguration property

An RTCConfiguration dictionary to pass to the RTCPeerConnection constructor. This allows you to configure the WebRTC connection between your local machine and the remote peer.

rtcConstraints property

A MediaStreamConstraints dictonary to pass to getUserMedia when making or accepting a Call. This allows you to configure the behavior of tracks returned in the MediaStream.

Each browser implements a different set of MediaTrackConstraints, so consult your browser's implementation of getUserMedia for more information.

device.destroy()

Destroys the Device instance.

This method will disconnect all calls, unbind audio devices, destroy the stream (which causes the unregistered event to be emitted), and then the Device instance will emit the destroyed event. Then, all event listeners attached to the Device instance are cleaned up.

const device = new Device(token);

device.destroy();

device.disconnectAll()

Disconnect all Calls associated with the Device instance.

Example:

A user clicks on a Hang Up button in the browser, which calls device.disconnectAll() to end the current Call.

const device = new Device(token);

// A click on a 'Hang Up' button calls this method
const hangupCall = () => {
 device.disconnectAll();
 console.log('The call has ended.');
}

device.emit(eventName, ...args)

Calls each of the event listeners registered for the event named eventName. The listeners will be called in the order they were registered. Any arguments passed in after the eventName will be passed to the event listeners.

See the Node.js Events Docs for more information.

device.eventNames()

Returns an array of event names for which the Device instance has registered event listeners.

See the Node.js Events Docs for more information.

device.getMaxListeners()

Returns the current maximum number of event listeners for the Device instance.

By default, the maximum number of listeners is 10, and is set by the static Device.defaultMaxListeners property or the dynamic device.setMaxListeners(number) method.

See the Node.js Events Docs for more information.

device.listenerCount(eventName)

Returns the number of listeners listening to the event named eventName on the Device instance.

See the Node.js Events Docs for more information.

device.listeners(eventName)

Returns an array of the listeners registered on the Device instance for the event named eventName.

See the Node.js Events Docs for more information.

device.off(eventName, listener)

Removes the listener for the event named eventName. This is an alias for device.removeListener().

const device = new Device(token);

const handleSuccessfulRegistration = () => {
  console.log('The device is ready to receive incoming calls.')
}

device.on('registered', handleSuccessfulRegistration);

device.off('registered', handleSuccessfulRegistration);

See the Node.js Event Docs for more information.

device.on(eventName, listener)

Add an event listener to the Device instance. This is analogous to the Device.addListener() method.

See the Events section of this page to see the full list of events emitted by the Device instance.

Example:

If you want to know when your Device instance is ready to receive incoming calls, listen for the 'registered' event.

const device = new Device(token);

device.on('registered', device => {
  console.log('The device is ready to receive incoming calls.')
};

device.once(eventName, listener)

Adds a one-time listener to the Device instance for the event named eventName.

See the Node.js Events Docs for more information.

device.prependListener(eventName, listener)

Adds a listener function to the beginning of the listeners array for the event named eventName.

Calling this multiple times with the same eventName and listener arguments will add the listener again, meaning that the listener will be called multiple times when the specified event is emitted.

See the Node.js Events Docs for more information.

device.prependOnceListener(eventName, listener)

Adds a one-time listener to the beginning of the listener array for the specified event.

See the Node.js Events Docs for more information.

device.rawListeners(eventName)

Returns an array of the listeners associated with the event named eventName. This includes any wrappers.

See the Node.js Events Docs for more information.

device.register()

Register the Device instance with Twilio, allowing it to receive incoming calls. This will open a signaling WebSocket, so the browser tab may show the 'recording' icon.

It is not necessary to call device.register() in order to make outgoing calls.

const device = new Device(token);

const handleSuccessfulRegistration = () => {
  console.log('The device is ready to receive incoming calls.')
}

device.on('registered', handleSuccessfulRegistration);

device.register();

Example:

A user clicks on a Start Device button that will fire device.register() to enable the Device instance to receive incoming calls. Once registered, the Device instance will emit the 'registered' event.

const device = new Device(token);

// Listen for the 'registered' event
device.on('registered', () => {
  console.log('The device is ready to receive calls.')
})

// A 'Start Device' button click calls this method
const startDevice = () => {
  console.log('Registering the device to receive calls.');
  device.register();
}

device.removeAllListeners(eventNames?)

Removes all listeners on the Device instance if no argument is passed. This is not recommended.

The optional eventNames parameter is an array of event name strings.

If eventNames argument is passed, only those listeners will be removed. This is only recommended for events and event listeners that you have added, not those created by the SDK.

const device = new Device(token);

// removes all event listeners
device.removeListeners();

// removes the listeners for the "event1" and "event2" events
device.removeListeners(["event1", "event2"]);

See the Node.js Events Docs for more information.

device.removeListener(eventName, listener)

Removes the listener specified by the eventName and listener arguments. This is analogous to device.off().

const device = new Device(token);

const handleSuccessfulRegistration = () => {
  console.log('The device is ready to receive incoming calls.')
}

device.on('registered', handleSuccessfulRegistration);

device.removeListener('registered', handleSuccessfulRegistration);

See the Node.js Events Docs for more information.

device.setMaxListeners(number)

Set the maximum number of event listeners allowed on this Device instance. The default maximum is 10.

Calling this method will change only the maximum allowed on this specific instance of a Device. If you want to change the maximum number of listeners allowed for all Device instances, consider setting the static Device.defaultMaxListeners property on the global Device object provided by the SDK.

Note: device.setMaxListeners(number) will have precedence over Device.defaultMaxListeners.

const device = new Device(token);

device.setMaxListeners(20);​

device.unregister()

Unregister the Device instance with Twilio. This will prevent the Device instance from receiving incoming calls.

The Device instance will emit the 'unregistered' event when successfully unregistered with Twilio.

const device = new Device(token);

// Listen for the 'unregistered' event
device.on('unregistered', () => {
  console.log('The device is no longer able to receive calls.')
})

const unregisterDevice = () => {
  console.log('Unregistering the device.');
  device.unregister();
}

device.updateOptions(options)

Set the options used within the Device instance.

See the DeviceOptions section above for the full list of available options.

Example:

Specify an Edge location and custom sounds

const options = {
  edge: 'ashburn', 
  sounds: {
    incoming: '',
    outgoing: '', 
    dtmf8: ''
  }
}

const device = new Device(token);
device.updateOptions(options);

device.updateToken(token)

Update the token used by this Device instance to connect to Twilio.

If the token expires, the Device instance will not be able to receive or make calls. It will also prevent statistics from being sent to Voice Insights.

In the future, as Twilio explores signaling reconnection support, keeping this token updated will be important for automatically restoring connection to a Call or re-registering the Device instance.

Example:

// time to live for the token, in milliseconds
const timeToLive = 600000; // 10 minutes
const refreshBuffer = 30000; // 30 seconds

const token = await getTokenViaAjax({ timeToLive });
const device = new Device(token);

setInterval(async () => {
  const newToken = await getTokenViaAjax({ timeToLive });
  device.updateToken(token);
}, timeToLive - refreshBuffer); 

Events

error Event

Emitted when the Device instance receives an error.

The event listener will receive a TwilioError and when applicable, a reference to the Call object that was active when the error occured. See the TwilioError section below for more information on the TwilioError object.

Listen for the 'error' event.

const device = new Device(token);

device.on('error', (twilioError, call) => {
 console.log('An error has occurred: ', twilioError);
});

TwilioError

The format of the TwilioError returned from the error event is a JavaScript object with the following properties:

See a list of common errors on the Voice SDK Error Codes Page.

incoming Event

Emitted when an incoming Call is received. An event listener will receive the Call object representing the incoming Call.

Listen for the 'incoming' event.

const device = new Device(token);

device.on('incoming', call => {
    // Do something
});

registered Event

Emitted when the Device instance is registered and able to receive incoming calls.

Listen for the 'registered' event.

const device = new Device(token);

device.on('registered', device => {
    // Do something
});

registering Event

Emitted when the Device instance is registering with Twilio to receive incoming calls.

Listen for the 'registering' event.

const device = new Device(token);

device.on('registering', device => {
    // Do something
});

tokenWillExpire Event

Emitted when the Device instance's AccessToken is about to expire.

Use the refreshTokenMs property on the DeviceOptions object to set a custom warning time. The default is 10 seconds (10000 milliseconds) prior to the AccessToken expiring.

Listen for the 'tokenWillExpire' event.

You can use this event along with device.updateToken() to automatically retrieve a new AccessToken and update the AccessToken on the Device instance, as shown in the example below:

device.on('tokenWillExpire', () => {
  const token = getNewTokenViaAjax();
  device.updateToken(token);
});

unregistered Event

Emitted when the Device instance has unregistered with Twilio.

Listen for the 'unregistered' event.

const device = new Device(token);

device.on('unregistered', call => 
    // Do something
});

Accessors

device.audio

Return the AudioHelper object used by the Device instance. See the device.audio docs for more information.

device.calls

Returns an array of Calls that this Device instance is maintaining.

Modifying one of these calls will have the same affect as modifying the same Call as it was returned by device.on('incoming') or device.connect().

const device = new Device(token);

// make an ougoing call
device.connect({ params: { To: "+15551234567" } });

console.log(device.calls);

// Prints: 
// []

device.edge

Returns the Edge value the Device instance is currently connected to. The value will be null when the Device instance is offline.

const device = new Device(token);

device.on("registered", () => {
  console.log(device.edge);
});

device.register();

// Prints: 
// ashburn

device.home

Returns the home Twilio Region the Device instance is connected to as a string. The value will be null when the Device instance is offline.

const device = new Device(token);

console.log(device.home);

// The default region for the JavaScript SDK is US-1

// Prints: 
// 'us1'

device.identity

Returns the identity string that is associated with the Device instance's current AccessToken.

This accessor is only populated when the Device instance has successfully registered with Twilio.

device.isBusy

Returns a Boolean for whether the Device instance is currently on an active Call

const device = new Device(token);

console.log(device.isBusy);

// Prints: 
// false



// make an outgoing call
device.connect({ params: { To: "+15551234567" });

console.log(device.isBusy);

// Prints: 
// true

device.state

Returns the state of the Device instance

const device = new Device(token);

console.log(device.state);

// Prints: 
// unregistered

The possible Device instance states are:

• unregistered - The Device instance is not registered with Twilio and cannot accept incoming calls
• registering - The Device instance is registering with Twilio to accept incoming calls
• registered - The Device instance is registered with Twilio and can accept incoming calls
• destroyed - The Device instance has been destroyed and will not be able to make or receive new calls

Use event listeners on the Device instance to give the user feedback when the Device instance's state changes. See the Best Practices Page for more information.

device.token

Returns the token used by this Device instance

const device = new Device(token);

console.log(device.token);

// Prints: 
// eyJhbGciOiJIUzI1NiIsInR5cCI6Ikp....

You can use the JWT debugger to decode and inspect the token.

Static Methods

Static methods should be called on the Device global object provided by the SDK.

Device.runPreflight(token, options?)

Returns a PreflightTest object representing a test call to Twilio which provides information to help troubleshoot call related issues.

Example:

const preflightTest = Device.runPreflight(token, options);

A Twilio.PreflightTest object represents a test call to Twilio which provides information to help troubleshoot call related issues. You never instantiate it directly, but it's returned when you call Device.runPreflight(token, options).

See the PreflightTest Page for more information.

Static Properties

Static properties are those properties that only exist on the global Device object.

Device.defaultMaxListeners

Use this to change the default maximum number of event listeners permitted on all instances of a Device.

Device.defaultMaxListeners = 20;

If you need to change the maximum number of event listeners on a specific Device instance, call the device.setMaxListeners(number) method on that instance.

Note: device.setMaxListeners(number) will have precedence over Device.defaultMaxListeners.

Static Accessors

Static accessors should be called on the Device global provided by the SDK.

Device.isSupported

Returns a Boolean for whether or not this SDK is supported by the current browser

console.log(Device.isSupported);

// Prints:
// true

Device.packageName

Returns the package name of the SDK

console.log(Device.packageName);

// Prints:
// @twilio/voice-sdk

Device.version

Returns the current SDK version

console.log(Device.version);

// Prints:
// 2.0.0