WebRTC JS Call

A Call is the representation of an audio or video call between two browsers, SIP clients or phone numbers. The call object is created whenever a new call is initiated, either by you or the remote caller. You can access and act upon calls initiated by a remote caller in a telnyx.notification event handler.

Examples

To create a new call, i.e. dial:

const call = client.newCall({
  // Destination is required and can be a phone number or SIP URI
  destinationNumber: '18004377950',
  callerNumber: '‬155531234567',
});

To answer an incoming call:

client.on('telnyx.notification', (notification) => {
  const call = notification.call;

  if (notification.type === 'callUpdate' && call.state === 'ringing') {
    call.answer();
  }
});

Both the outgoing and incoming call has methods that can be hooked up to your UI.

// Hangup or reject an incoming call
call.hangup();

// Send digits and keypresses
call.dtmf('1234');

// Call states that can be toggled
call.hold();
call.muteAudio();

Hierarchy

default

↳ Call

Properties

direction

• direction: Direction

The direction of the call. Can be either inbound or outbound.

Inherited from

BaseCall.direction

id

• id: string = ''

The call identifier.

Inherited from

BaseCall.id

prevState

• prevState: string = ''

The previous state of the call. See Call.state for all possible values.

Inherited from

BaseCall.prevState

recoveredCallId

• recoveredCallId: string = ''

The call ID of the previous call that this call is recovering from. Present only when the call was created as part of a reattachment/recovery flow (e.g. after a network reconnection).

Use this to match the new call object to the ended/destroyed call and prevent duplicate UI elements such as dialers.

Example

client.on('telnyx.notification', (notification) => {
  if (notification.type === 'callUpdate') {
    const call = notification.call;
    if (call.recoveredCallId) {
      // This call replaced a previous call after recovery
      // Remove the old dialer for call.recoveredCallId
      removeDialer(call.recoveredCallId);
    }
  }
});

Inherited from

BaseCall.recoveredCallId

state

• state: string

The state of the call.

Value	Description
`new`	New call has been created in the client.
`trying`	It's attempting to call someone.
`requesting`	The outbound call is being sent to the server.
`recovering`	The previous call is recovering after the page refreshes. If the user refreshes the page during a call, it will automatically join the latest call.
`ringing`	Someone is attempting to call you.
`answering`	You are attempting to answer this inbound call.
`early`	It receives the media before the call has been answered.
`active`	Call has become active.
`held`	Call has been held.
`hangup`	Call has ended.
`destroy`	Call has been destroyed.
`purge`	Call has been purged.

Inherited from

BaseCall.state

Accessors

isAudioMuted

• get isAudioMuted(): boolean

Checks whether the microphone is muted.

Returns

boolean

Examples

call.isAudioMuted();

Inherited from

BaseCall.isAudioMuted

localStream

• get localStream(): MediaStream

Gets the local stream of the call. This can be used in a video/audio element to play the local media. See MediaStream.

Returns

MediaStream

Examples

const stream = call.localStream;
document.querySelector('audio').srcObject = stream;

Inherited from

BaseCall.localStream

remoteStream

• get remoteStream(): MediaStream

Gets the remote stream of the call. This can be used in a video/audio element to play the remote media. See MediaStream.

Returns

MediaStream

Examples

const stream = call.remoteStream;
document.querySelector('audio').srcObject = stream;

Name	Type
`telnyxCallControlId`	`string`
`telnyxLegId`	`string`
`telnyxSessionId`	`string`

Examples

const { telnyxCallControlId, telnyxSessionId, telnyxLegId } = call.telnyxIDs;

Name	Type
`params`	`AnswerParams`

Returns

Promise<void>

Examples

call.answer();

call.deaf();

Name	Type	Description
`dtmf`	`string`	Single DTMF key

Returns

void

Examples

call.dtmf('0');
call.dtmf('1');
call.dtmf('*');
call.dtmf('#');

Name	Type
`callback`	`Function`
`constraints`	`any`

Examples

Using async/await:

await call.hold();
console.log(call.state); // => 'held'

Using ES6 Promises:

call.hold().then(() => {
  console.log(call.state); // => 'held'
});

call.muteAudio();

call.muteVideo();

Deprecated

Name	Type	Description
`deviceId`	`string`	The target audio input device ID
`muted`	`boolean`	Whether the audio track should be muted. Defaults to `mutedMicOnStart` call option.

Returns

Promise<void>

Promise that resolves if the audio input device has been updated

Examples

Using async/await:

await call.setAudioInDevice('abc123');

Using ES6 Promises:

call.setAudioInDevice('abc123').then(() => {
  // Do something using new audio input device
});

Usage with .getAudioInDevices:

let result = await client.getAudioInDevices();

if (result.length) {
  call.setAudioInDevice(result[1].deviceId);
}

Name	Type	Description
`deviceId`	`string`	The target audio output device ID

Returns

Promise<boolean>

Promise that returns a boolean

Examples

Using async/await:

await call.setAudioOutDevice('abc123');

Using ES6 Promises:

call.setAudioOutDevice('abc123').then(() => {
  // Do something using new audio output device
});

Usage with .getAudioOutDevices:

let result = await client.getAudioOutDevices();

if (result.length) {
  await call.setAudioOutDevice(result[1].deviceId);
}

setVideoDevice

▸ setVideoDevice(deviceId): Promise<void>

Changes the video device (i.e. webcam) used for the call.

Parameters

Name	Type	Description
`deviceId`	`string`	the target video device ID

Returns

Promise<void>

Promise that resolves if the video device has been updated

Examples

Using async/await:

await call.setVideoDevice('abc123');

Using ES6 Promises:

call.setVideoDevice('abc123').then(() => {
  // Do something using new video device
});

Usage with .getVideoDevices:

let result = await client.getVideoDevices();

if (result.length) {
  await call.setVideoDevice(result[1].deviceId);
}

Deprecated

call.toggleAudioMute();

call.toggleDeaf();

Examples

Using async/await:

await call.toggleHold();
console.log(call.state); // => 'held'

await call.toggleHold();
console.log(call.state); // => 'active'

call.toggleVideoMute();

Deprecated

call.undeaf();

Examples

Using async/await:

await call.unhold();
console.log(call.state); // => 'active'

Using ES6 Promises:

call.unhold().then(() => {
  console.log(call.state); // => 'active'
});

call.unmuteAudio();

call.unmuteVideo();

Deprecated

Inherited from

BaseCall.unmuteVideo