> ## Documentation Index > Fetch the complete documentation index at: https://developers.telnyx.com/llms.txt > Use this file to discover all available pages before exploring further. # WebRTC JS Call > Reference for the Call class in the JS Voice SDK — represents a browser call you can accept, decline, hold, mute, transfer, or send DTMF on. 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: ```js theme={null} 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: ```js theme={null} 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. ```js theme={null} // 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`** ## Table of contents ### Properties * [direction](#direction) * [id](#id) * [prevState](#prevstate) * [recoveredCallId](#recoveredcallid) * [state](#state) ### Accessors * [isAudioMuted](#isaudiomuted) * [localStream](#localstream) * [remoteStream](#remotestream) * [signalingStateClosed](#signalingstateclosed) * [telnyxIDs](#telnyxids) ### Methods * [answer](#answer) * [deaf](#deaf) * [dtmf](#dtmf) * [getStats](#getstats) * [hold](#hold) * [muteAudio](#muteaudio) * [muteVideo](#mutevideo) * [setAudioInDevice](#setaudioindevice) * [setAudioOutDevice](#setaudiooutdevice) * [setVideoDevice](#setvideodevice) * [toggleAudioMute](#toggleaudiomute) * [toggleDeaf](#toggledeaf) * [toggleHold](#togglehold) * [toggleVideoMute](#togglevideomute) * [undeaf](#undeaf) * [unhold](#unhold) * [unmuteAudio](#unmuteaudio) * [unmuteVideo](#unmutevideo) ## 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`** ```js theme={null} 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`** ```js theme={null} 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](https://developer.mozilla.org/en-US/docs/Web/API/MediaStream). #### Returns `MediaStream` **`Examples`** ```js theme={null} 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](https://developer.mozilla.org/en-US/docs/Web/API/MediaStream). #### Returns `MediaStream` **`Examples`** ```js theme={null} const stream = call.remoteStream; document.querySelector('audio').srcObject = stream; ``` #### Inherited from BaseCall.remoteStream *** ### signalingStateClosed • `get` **signalingStateClosed**(): `boolean` Indicates if the peer connection's signaling state has transitioned to 'closed' while the connection was previously active. Used to determine if the call can be recovered on reconnection. #### Returns `boolean` #### Inherited from BaseCall.signalingStateClosed *** ### telnyxIDs • `get` **telnyxIDs**(): `Object` Gets Telnyx call IDs, if using Telnyx Call Control services. You can use these IDs to identify specific calls in your application code. #### Returns `Object` | Name | Type | | :-------------------- | :------- | | `telnyxCallControlId` | `string` | | `telnyxLegId` | `string` | | `telnyxSessionId` | `string` | **`Examples`** ```js theme={null} const { telnyxCallControlId, telnyxSessionId, telnyxLegId } = call.telnyxIDs; ``` #### Inherited from BaseCall.telnyxIDs ## Methods ### answer ▸ **answer**(`params?`): `Promise`\<`void`> Starts the process to answer the incoming call. #### Parameters | Name | Type | | :------- | :------------- | | `params` | `AnswerParams` | #### Returns `Promise`\<`void`> **`Examples`** ```js theme={null} call.answer(); ``` #### Inherited from BaseCall.answer *** ### deaf ▸ **deaf**(): `void` Turns off the remote stream audio. #### Returns `void` **`Examples`** ```js theme={null} call.deaf(); ``` #### Inherited from BaseCall.deaf *** ### dtmf ▸ **dtmf**(`dtmf`): `void` Sends dual-tone multi-frequency (DTMF) signal #### Parameters | Name | Type | Description | | :----- | :------- | :-------------- | | `dtmf` | `string` | Single DTMF key | #### Returns `void` **`Examples`** ```js theme={null} call.dtmf('0'); call.dtmf('1'); call.dtmf('*'); call.dtmf('#'); ``` #### Inherited from BaseCall.dtmf *** ### getStats ▸ **getStats**(`callback`, `constraints`): `void` Registers callback for stats. #### Parameters | Name | Type | | :------------ | :--------- | | `callback` | `Function` | | `constraints` | `any` | #### Returns `void` #### Inherited from BaseCall.getStats *** ### hold ▸ **hold**(): `Promise`\<`any`> Holds the call. #### Returns `Promise`\<`any`> Promise that resolves or rejects based on server response **`Examples`** Using async/await: ```js theme={null} await call.hold(); console.log(call.state); // => 'held' ``` Using ES6 `Promises`: ```js theme={null} call.hold().then(() => { console.log(call.state); // => 'held' }); ``` #### Inherited from BaseCall.hold *** ### muteAudio ▸ **muteAudio**(): `void` Turns off audio output, i.e. makes it so other call participants cannot hear your audio. #### Returns `void` **`Examples`** ```js theme={null} call.muteAudio(); ``` #### Inherited from BaseCall.muteAudio *** ### muteVideo ▸ **muteVideo**(): `void` Turns off the video output, i.e. hides video from other call participants. #### Returns `void` **`Examples`** ```js theme={null} call.muteVideo(); ``` **`Deprecated`** #### Inherited from BaseCall.muteVideo *** ### setAudioInDevice ▸ **setAudioInDevice**(`deviceId`, `muted?`): `Promise`\<`void`> Changes the audio input device (i.e. microphone) used for the call. #### Parameters | 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: ```js theme={null} await call.setAudioInDevice('abc123'); ``` Using ES6 `Promises`: ```js theme={null} call.setAudioInDevice('abc123').then(() => { // Do something using new audio input device }); ``` Usage with `.getAudioInDevices`: ```js theme={null} let result = await client.getAudioInDevices(); if (result.length) { call.setAudioInDevice(result[1].deviceId); } ``` #### Inherited from BaseCall.setAudioInDevice *** ### setAudioOutDevice ▸ **setAudioOutDevice**(`deviceId`): `Promise`\<`boolean`> Changes the audio output device (i.e. speaker) used for the call. #### Parameters | Name | Type | Description | | :--------- | :------- | :-------------------------------- | | `deviceId` | `string` | The target audio output device ID | #### Returns `Promise`\<`boolean`> Promise that returns a boolean **`Examples`** Using async/await: ```js theme={null} await call.setAudioOutDevice('abc123'); ``` Using ES6 `Promises`: ```js theme={null} call.setAudioOutDevice('abc123').then(() => { // Do something using new audio output device }); ``` Usage with `.getAudioOutDevices`: ```js theme={null} 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: ```js theme={null} await call.setVideoDevice('abc123'); ``` Using ES6 `Promises`: ```js theme={null} call.setVideoDevice('abc123').then(() => { // Do something using new video device }); ``` Usage with `.getVideoDevices`: ```js theme={null} let result = await client.getVideoDevices(); if (result.length) { await call.setVideoDevice(result[1].deviceId); } ``` **`Deprecated`** #### Inherited from BaseCall.setVideoDevice *** ### toggleAudioMute ▸ **toggleAudioMute**(): `void` Toggles the audio output on/off. #### Returns `void` **`Examples`** ```js theme={null} call.toggleAudioMute(); ``` #### Inherited from BaseCall.toggleAudioMute *** ### toggleDeaf ▸ **toggleDeaf**(): `void` Toggles the remote stream audio. #### Returns `void` **`Examples`** ```js theme={null} call.toggleDeaf(); ``` #### Inherited from BaseCall.toggleDeaf *** ### toggleHold ▸ **toggleHold**(): `Promise`\<`any`> Toggles hold state of the call. #### Returns `Promise`\<`any`> Promise that resolves or rejects based on server response **`Examples`** Using async/await: ```js theme={null} await call.toggleHold(); console.log(call.state); // => 'held' await call.toggleHold(); console.log(call.state); // => 'active' ``` #### Inherited from BaseCall.toggleHold *** ### toggleVideoMute ▸ **toggleVideoMute**(): `void` Toggles the video output on/off. #### Returns `void` **`Examples`** ```js theme={null} call.toggleVideoMute(); ``` **`Deprecated`** #### Inherited from BaseCall.toggleVideoMute *** ### undeaf ▸ **undeaf**(): `void` Turns on the remote stream audio. #### Returns `void` **`Examples`** ```js theme={null} call.undeaf(); ``` #### Inherited from BaseCall.undeaf *** ### unhold ▸ **unhold**(): `Promise`\<`any`> Removes hold from the call. #### Returns `Promise`\<`any`> Promise that resolves or rejects based on server response **`Examples`** Using async/await: ```js theme={null} await call.unhold(); console.log(call.state); // => 'active' ``` Using ES6 `Promises`: ```js theme={null} call.unhold().then(() => { console.log(call.state); // => 'active' }); ``` #### Inherited from BaseCall.unhold *** ### unmuteAudio ▸ **unmuteAudio**(): `void` Turns on audio output, i.e. makes it so other call participants can hear your audio. #### Returns `void` **`Examples`** ```js theme={null} call.unmuteAudio(); ``` #### Inherited from BaseCall.unmuteAudio *** ### unmuteVideo ▸ **unmuteVideo**(): `void` Turns on the video output, i.e. makes video visible to other call participants. #### Returns `void` **`Examples`** ```js theme={null} call.unmuteVideo(); ``` **`Deprecated`** #### Inherited from BaseCall.unmuteVideo