@salesforce/scv-connector-base
Version:
Salesforce Service Cloud Connector Base
3,738 lines • 41.6 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: TelephonyConnector</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: TelephonyConnector</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>TelephonyConnector<span class="signature">()</span><span class="type-signature"></span></h2>
<div class="class-description">Class representing a TelephonyConnector</div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="TelephonyConnector"><span class="type-signature"></span>new TelephonyConnector<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="types.js.html">types.js</a>, <a href="types.js.html#line1077">line 1077</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="acceptCall"><span class="type-signature"></span>acceptCall<span class="signature">(call)</span><span class="type-signature"> → {Promise.<<a href="CallResult.html">CallResult</a>>}</span></h4>
<div class="description">
Accept call
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>call</code></td>
<td class="type">
<span class="param-type"><a href="PhoneCall.html">PhoneCall</a></span>
</td>
<td class="description last">The call to be accepted</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="types.js.html">types.js</a>, <a href="types.js.html#line1093">line 1093</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="CallResult.html">CallResult</a>></span>
</dd>
</dl>
<h4 class="name" id="addParticipant"><span class="type-signature"></span>addParticipant<span class="signature">(contact:, parentCall:, isBlindTransfer:)</span><span class="type-signature"> → {Promise.<<a href="ParticipantResult.html">ParticipantResult</a>>}</span></h4>
<div class="description">
Add participant to call
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>contact:</code></td>
<td class="type">
<span class="param-type"><a href="Contact.html">Contact</a></span>
</td>
<td class="description last">The transfer target</td>
</tr>
<tr>
<td class="name"><code>parentCall:</code></td>
<td class="type">
<span class="param-type"><a href="PhoneCall.html">PhoneCall</a></span>
</td>
<td class="description last">The call to which a participant will be added</td>
</tr>
<tr>
<td class="name"><code>isBlindTransfer:</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="description last">True if blind transfering a call and hanging up upon transfer</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="types.js.html">types.js</a>, <a href="types.js.html#line1212">line 1212</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="ParticipantResult.html">ParticipantResult</a>></span>
</dd>
</dl>
<h4 class="name" id="conference"><span class="type-signature"></span>conference<span class="signature">(calls)</span><span class="type-signature"> → {Promise.<<a href="HoldToggleResult.html">HoldToggleResult</a>>}</span></h4>
<div class="description">
Conference calls
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>calls</code></td>
<td class="type">
<span class="param-type">Array.<<a href="PhoneCall.html">PhoneCall</a>></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="types.js.html">types.js</a>, <a href="types.js.html#line1201">line 1201</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="HoldToggleResult.html">HoldToggleResult</a>></span>
</dd>
</dl>
<h4 class="name" id="declineCall"><span class="type-signature"></span>declineCall<span class="signature">(call)</span><span class="type-signature"> → {Promise.<<a href="CallResult.html">CallResult</a>>}</span></h4>
<div class="description">
Decline call
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>call</code></td>
<td class="type">
<span class="param-type"><a href="PhoneCall.html">PhoneCall</a></span>
</td>
<td class="description last">The call to be declined</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="types.js.html">types.js</a>, <a href="types.js.html#line1103">line 1103</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="CallResult.html">CallResult</a>></span>
</dd>
</dl>
<h4 class="name" id="dial"><span class="type-signature"></span>dial<span class="signature">(contact, dialOptions)</span><span class="type-signature"> → {Promise.<<a href="CallResult.html">CallResult</a>>}</span></h4>
<div class="description">
Dial out Number
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>contact</code></td>
<td class="type">
<span class="param-type"><a href="Contact.html">Contact</a></span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>dialOptions</code></td>
<td class="type">
<span class="param-type"><a href="DialOptions.html">DialOptions</a></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="types.js.html">types.js</a>, <a href="types.js.html#line1165">line 1165</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="CallResult.html">CallResult</a>></span>
</dd>
</dl>
<h4 class="name" id="endCall"><span class="type-signature"></span>endCall<span class="signature">(call, agentStatus)</span><span class="type-signature"> → {Promise.<<a href="HangupResult.html">HangupResult</a>>}</span></h4>
<div class="description">
End call
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>call</code></td>
<td class="type">
<span class="param-type"><a href="PhoneCall.html">PhoneCall</a></span>
</td>
<td class="description last">The call to be ended</td>
</tr>
<tr>
<td class="name"><code>agentStatus</code></td>
<td class="type">
<span class="param-type">AGENT_STATUS</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="types.js.html">types.js</a>, <a href="types.js.html#line1114">line 1114</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="HangupResult.html">HangupResult</a>></span>
</dd>
</dl>
<h4 class="name" id="getActiveCalls"><span class="type-signature"></span>getActiveCalls<span class="signature">()</span><span class="type-signature"> → {Promise.<<a href="ActiveCallsResult.html">ActiveCallsResult</a>>}</span></h4>
<div class="description">
Get the currently active calls
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="types.js.html">types.js</a>, <a href="types.js.html#line1083">line 1083</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="ActiveCallsResult.html">ActiveCallsResult</a>></span>
</dd>
</dl>
<h4 class="name" id="getAgentConfig"><span class="type-signature"></span>getAgentConfig<span class="signature">()</span><span class="type-signature"> → {Promise.<<a href="AgentConfigResult.html">AgentConfigResult</a>>}</span></h4>
<div class="description">
Get agentConfig
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="types.js.html">types.js</a>, <a href="types.js.html#line1236">line 1236</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="AgentConfigResult.html">AgentConfigResult</a>></span>
</dd>
</dl>
<h4 class="name" id="getPhoneContacts"><span class="type-signature"></span>getPhoneContacts<span class="signature">(filterType)</span><span class="type-signature"> → {Promise.<<a href="PhoneContactsResult.html">PhoneContactsResult</a>>}</span></h4>
<div class="description">
Get phone contacts
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>filterType</code></td>
<td class="type">
<span class="param-type"><a href="ContactsFilter.html">ContactsFilter</a></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="types.js.html">types.js</a>, <a href="types.js.html#line1182">line 1182</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="PhoneContactsResult.html">PhoneContactsResult</a>></span>
</dd>
</dl>
<h4 class="name" id="getSignedRecordingUrl"><span class="type-signature"></span>getSignedRecordingUrl<span class="signature">(recordingUrl, vendorCallKey, callId)</span><span class="type-signature"> → {Promise.<<a href="SignedRecordingUrlResult.html">SignedRecordingUrlResult</a>>}</span></h4>
<div class="description">
Get the signed recording url
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>recordingUrl</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>vendorCallKey</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>callId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="types.js.html">types.js</a>, <a href="types.js.html#line1272">line 1272</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="SignedRecordingUrlResult.html">SignedRecordingUrlResult</a>></span>
</dd>
</dl>
<h4 class="name" id="getVoiceCapabilities"><span class="type-signature"></span>getVoiceCapabilities<span class="signature">()</span><span class="type-signature"> → {Promise.<<a href="VoiceCapabilitiesResult.html">VoiceCapabilitiesResult</a>>}</span></h4>
<div class="description">
Get voice capabilities
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="types.js.html">types.js</a>, <a href="types.js.html#line1253">line 1253</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="VoiceCapabilitiesResult.html">VoiceCapabilitiesResult</a>></span>
</dd>
</dl>
<h4 class="name" id="hold"><span class="type-signature"></span>hold<span class="signature">(call)</span><span class="type-signature"> → {Promise.<<a href="HoldToggleResult.html">HoldToggleResult</a>>}</span></h4>
<div class="description">
Hold call
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>call</code></td>
<td class="type">
<span class="param-type"><a href="PhoneCall.html">PhoneCall</a></span>
</td>
<td class="description last">The call to be held</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="types.js.html">types.js</a>, <a href="types.js.html#line1144">line 1144</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="HoldToggleResult.html">HoldToggleResult</a>></span>
</dd>
</dl>
<h4 class="name" id="mute"><span class="type-signature"></span>mute<span class="signature">(call)</span><span class="type-signature"> → {Promise.<<a href="MuteToggleResult.html">MuteToggleResult</a>>}</span></h4>
<div class="description">
Mute call
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>call</code></td>
<td class="type">
<span class="param-type"><a href="PhoneCall.html">PhoneCall</a></span>
</td>
<td class="description last">(an optional participant call to mute)</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="types.js.html">types.js</a>, <a href="types.js.html#line1124">line 1124</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="MuteToggleResult.html">MuteToggleResult</a>></span>
</dd>
</dl>
<h4 class="name" id="pauseRecording"><span class="type-signature"></span>pauseRecording<span class="signature">()</span><span class="type-signature"> → {Promise.<<a href="RecordingToggleResult.html">RecordingToggleResult</a>>}</span></h4>
<div class="description">
Pause recording
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="types.js.html">types.js</a>, <a href="types.js.html#line1220">line 1220</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="RecordingToggleResult.html">RecordingToggleResult</a>></span>
</dd>
</dl>
<h4 class="name" id="resume"><span class="type-signature"></span>resume<span class="signature">(call)</span><span class="type-signature"> → {Promise.<<a href="HoldToggleResult.html">HoldToggleResult</a>>}</span></h4>
<div class="description">
Resume call
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>call</code></td>
<td class="type">
<span class="param-type"><a href="PhoneCall.html">PhoneCall</a></span>
</td>
<td class="description last">The call to be resumed</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="types.js.html">types.js</a>, <a href="types.js.html#line1154">line 1154</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="HoldToggleResult.html">HoldToggleResult</a>></span>
</dd>
</dl>
<h4 class="name" id="resumeRecording"><span class="type-signature"></span>resumeRecording<span class="signature">()</span><span class="type-signature"> → {Promise.<<a href="RecordingToggleResult.html">RecordingToggleResult</a>>}</span></h4>
<div class="description">
Resume recording
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="types.js.html">types.js</a>, <a href="types.js.html#line1228">line 1228</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="RecordingToggleResult.html">RecordingToggleResult</a>></span>
</dd>
</dl>
<h4 class="name" id="sendDigits"><span class="type-signature"></span>sendDigits<span class="signature">(digits)</span><span class="type-signature"></span></h4>
<div class="description">
Send digits
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>digits</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="types.js.html">types.js</a>, <a href="types.js.html#line1173">line 1173</a>
</li></ul></dd>
</dl>
<h4 class="name" id="setAgentConfig"><span class="type-signature"></span>setAgentConfig<span class="signature">(config)</span><span class="type-signature"> → {Promise.<<a href="GenericResult.html">GenericResult</a>>}</span></h4>
<div class="description">
Set Agent Config
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>config</code></td>
<td class="type">
<span class="param-type"><a href="AgentConfig.html">AgentConfig</a></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="types.js.html">types.js</a>, <a href="types.js.html#line1245">line 1245</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="GenericResult.html">GenericResult</a>></span>
</dd>
</dl>
<h4 class="name" id="superviseCall"><span class="type-signature"></span>superviseCall<span class="signature">(supervisedCallInfo)</span><span class="type-signature"></span></h4>
<div class="description">
Supervise a call
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>supervisedCallInfo</code></td>
<td class="type">
<span class="param-type"><a href="SupervisedCallInfo.html">SupervisedCallInfo</a></span>
</td>
<td class="description last">CallInfo of the call to be supervised</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="types.js.html">types.js</a>, <a href="types.js.html#line1281">line 1281</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<h4 class="name" id="supervisorBargeIn"><span class="type-signature"></span>supervisorBargeIn<span class="signature">(supervisedCallInfo)</span><span class="type-signature"></span></h4>
<div class="description">
Supervisor Barges into a ongoing call
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>supervisedCallInfo</code></td>
<td class="type">
<span class="param-type"><a href="SupervisedCallInfo.html">SupervisedCallInfo</a></span>
</td>
<td class="description last">CallInfo of the supervised call which supervisor barges in</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="types.js.html">types.js</a>, <a href="types.js.html#line1299">line 1299</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<h4 class="name" id="supervisorDisconnect"><span class="type-signature"></span>supervisorDisconnect<span class="signature">(supervisedCallInfo)</span><span class="type-signature"></span></h4>
<div class="description">
Supervisor disconnects from a call
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>supervisedCallInfo</code></td>
<td class="type">
<span class="param-type"><a href="SupervisedCallInfo.html">SupervisedCallInfo</a></span>
</td>
<td class="description last">CallInfo of the supervised call to be disconnected</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="types.js.html">types.js</a>, <a href="types.js.html#line1290">line 1290</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<h4 class="name" id="swap"><span class="type-signature"></span>swap<span class="signature">(call1, call2)</span><span class="type-signature"> → {Promise.<<a href="HoldToggleResult.html">HoldToggleResult</a>>}</span></h4>
<div class="description">
Swap calls
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>call1</code></td>
<td class="type">
<span class="param-type"><a href="PhoneCall.html">PhoneCall</a></span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>call2</code></td>
<td class="type">
<span class="param-type"><a href="PhoneCall.html">PhoneCall</a></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="types.js.html">types.js</a>, <a href="types.js.html#line1192">line 1192</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="HoldToggleResult.html">HoldToggleResult</a>></span>
</dd>
</dl>
<h4 class="name" id="unmute"><span class="type-signature"></span>unmute<span class="signature">(call)</span><span class="type-signature"> → {Promise.<<a href="MuteToggleResult.html">MuteToggleResult</a>>}</span></h4>
<div class="description">
Unmute call
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>call</code></td>
<td class="type">
<span class="param-type"><a href="PhoneCall.html">PhoneCall</a></span>
</td>
<td class="description last">(an optional participant call to unmute)</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="types.js.html">types.js</a>, <a href="types.js.html#line1134">line 1134</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<<a href="MuteToggleResult.html">MuteToggleResult</a>></span>
</dd>
</dl>
<h4 class="name" id="wrapUpCall"><span class="type-signature"></span>wrapUpCall<span class="signature">(call)</span><span class="type-signature"></span></h4>
<div class="description">
Wrap up call
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>call</code></td>
<td class="type">
<span class="param-type"><a href="PhoneCall.html">PhoneCall</a></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="types.js.html">types.js</a>, <a href="types.js.html#line1261">line 1261</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="ActiveCallsResult.html">ActiveCallsResult</a></li><li><a href="ACWInfo.html">ACWInfo</a></li><li><a href="AgentConfig.html">AgentConfig</a></li><li><a href="AgentConfigResult.html">AgentConfigResult</a></li><li><a href="AgentStatusInfo.html">AgentStatusInfo</a></li><li><a href="AgentVendorStatusInfo.html">AgentVendorStatusInfo</a></li><li><a href="AgentWork.html">AgentWork</a></li><li><a href="AudioDevicesResult.html">AudioDevicesResult</a></li><li><a href="AudioStats.html">AudioStats</a></li><li><a href="AudioStatsElement.html">AudioStatsElement</a></li><li><a href="CallInfo.html">CallInfo</a></li><li><a href="CallResult.html">CallResult</a></li><li><a href="Contact.html">Contact</a></li><li><a href="ContactsFilter.html">ContactsFilter</a></li><li><a href="ContactsResult.html">ContactsResult</a></li><li><a href="CustomError.html">CustomError</a></li><li><a href="DialOptions.html">DialOptions</a></li><li><a href="GenericResult.html">GenericResult</a></li><li><a href="HangupResult.html">HangupResult</a></li><li><a href="HidDevice.html">HidDevice</a></li><li><a href="HoldToggleResult.html">HoldToggleResult</a></li><li><a href="InitResult.html">InitResult</a></li><li><a href="LogoutResult.html">LogoutResult</a></li><li><a href="MuteToggleResult.html">MuteToggleResult</a></li><li><a href="ParticipantResult.html">ParticipantResult</a></li><li><a href="Phone.html">Phone</a></li><li><a href="PhoneCall.html">PhoneCall</a></li><li><a href="PhoneCallAttributes.html">PhoneCallAttributes</a></li><li><a href="PhoneContactsResult.html">PhoneContactsResult</a></li><li><a href="RecordingToggleResult.html">RecordingToggleResult</a></li><li><a href="SetAgentConfigResult.html">SetAgentConfigResult</a></li><li><a href="SetAgentStateResult.html">SetAgentStateResult</a></li><li><a href="SharedCapabilitiesResult.html">SharedCapabilitiesResult</a></li><li><a href="ShowStorageAccessResult.html">ShowStorageAccessResult</a></li><li><a href="SignedRecordingUrlResult.html">SignedRecordingUrlResult</a></li><li><a href="StateChangeResult.html">StateChangeResult</a></li><li><a href="StatsInfo.html">StatsInfo</a></li><li><a href="SuperviseCallResult.html">SuperviseCallResult</a></li><li><a href="SupervisedCallInfo.html">SupervisedCallInfo</a></li><li><a href="SupervisorHangupResult.html">SupervisorHangupResult</a></li><li><a href="TelephonyConnector.html">TelephonyConnector</a></li><li><a href="VendorConnector.html">VendorConnector</a></li><li><a href="VoiceCapabilitiesResult.html">VoiceCapabilitiesResult</a></li></ul><h3>Global</h3><ul><li><a href="global.html#CONNECTOR_CONFIG_EXCEPTION_FIELDS">CONNECTOR_CONFIG_EXCEPTION_FIELDS</a></li><li><a href="global.html#CONNECTOR_CONFIG_EXPOSED_FIELDS">CONNECTOR_CONFIG_EXPOSED_FIELDS</a></li><li><a href="global.html#CONNECTOR_CONFIG_EXPOSED_FIELDS_STARTSWITH">CONNECTOR_CONFIG_EXPOSED_FIELDS_STARTSWITH</a></li><li><a href="global.html#dispatchCustomError">dispatchCustomError</a></li><li><a href="global.html#dispatchError">dispatchError</a></li><li><a href="global.html#dispatchEvent">dispatchEvent</a></li><li><a href="global.html#dispatchEventLog">dispatchEventLog</a></li><li><a href="global.html#downloadData">downloadData</a></li><li><a href="global.html#downloadLogs">downloadLogs</a></li><li><a href="global.html#getErrorMessage">getErrorMessage</a></li><li><a href="global.html#getErrorType">getErrorType</a></li><li><a href="global.html#getLogs">getLogs</a></li><li><a href="global.html#initializeConnector">initializeConnector</a></li><li><a href="global.html#log">log</a></li><li><a href="global.html#publishError">publishError</a></li><li><a href="global.html#publishEvent">publishEvent</a></li><li><a href="global.html#publishLog">publishLog</a></li><li><a href="global.html#sanitizePayload">sanitizePayload</a></li><li><a href="global.html#setConnectorReady">setConnectorReady</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Tue Nov 25 2025 17:31:06 GMT-0500 (Eastern Standard Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>