UNPKG

scv-connector-base

Version:
3,671 lines (849 loc) 40 kB
<!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#line792">line 792</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"> &rarr; {Promise.&lt;<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#line808">line 808</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.&lt;<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"> &rarr; {Promise.&lt;<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#line924">line 924</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.&lt;<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"> &rarr; {Promise.&lt;<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.&lt;<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#line913">line 913</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.&lt;<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"> &rarr; {Promise.&lt;<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#line818">line 818</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.&lt;<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"> &rarr; {Promise.&lt;<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#line878">line 878</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.&lt;<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"> &rarr; {Promise.&lt;<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#line829">line 829</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.&lt;<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"> &rarr; {Promise.&lt;<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#line798">line 798</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.&lt;<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"> &rarr; {Promise.&lt;<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#line950">line 950</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.&lt;<a href="AgentConfigResult.html">AgentConfigResult</a>></span> </dd> </dl> <h4 class="name" id="getCapabilities"><span class="type-signature"></span>getCapabilities<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="CapabilitiesResult.html">CapabilitiesResult</a>>}</span></h4> <div class="description"> Get 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#line967">line 967</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.&lt;<a href="CapabilitiesResult.html">CapabilitiesResult</a>></span> </dd> </dl> <h4 class="name" id="getPhoneContacts"><span class="type-signature"></span>getPhoneContacts<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="PhoneContactsResult.html">PhoneContactsResult</a>>}</span></h4> <div class="description"> Get phone contacts </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#line894">line 894</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.&lt;<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"> &rarr; {Promise.&lt;<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#line986">line 986</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.&lt;<a href="SignedRecordingUrlResult.html">SignedRecordingUrlResult</a>></span> </dd> </dl> <h4 class="name" id="hold"><span class="type-signature"></span>hold<span class="signature">(call)</span><span class="type-signature"> &rarr; {Promise.&lt;<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#line857">line 857</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.&lt;<a href="HoldToggleResult.html">HoldToggleResult</a>></span> </dd> </dl> <h4 class="name" id="mute"><span class="type-signature"></span>mute<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="MuteToggleResult.html">MuteToggleResult</a>>}</span></h4> <div class="description"> Mute call </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#line838">line 838</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.&lt;<a href="MuteToggleResult.html">MuteToggleResult</a>></span> </dd> </dl> <h4 class="name" id="pauseRecording"><span class="type-signature"></span>pauseRecording<span class="signature">(call)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="RecordingToggleResult.html">RecordingToggleResult</a>>}</span></h4> <div class="description"> Pause recording </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#line933">line 933</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.&lt;<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"> &rarr; {Promise.&lt;<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#line867">line 867</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.&lt;<a href="HoldToggleResult.html">HoldToggleResult</a>></span> </dd> </dl> <h4 class="name" id="resumeRecording"><span class="type-signature"></span>resumeRecording<span class="signature">(call)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="RecordingToggleResult.html">RecordingToggleResult</a>>}</span></h4> <div class="description"> Resume recording </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#line942">line 942</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.&lt;<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#line886">line 886</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"> &rarr; {Promise.&lt;<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#line959">line 959</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.&lt;<a href="GenericResult.html">GenericResult</a>></span> </dd> </dl> <h4 class="name" id="superviseCall"><span class="type-signature"></span>superviseCall<span class="signature">(call)</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>call</code></td> <td class="type"> <span class="param-type"><a href="PhoneCall.html">PhoneCall</a></span> </td> <td class="description last">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#line994">line 994</a> </li></ul></dd> </dl> <h4 class="name" id="supervisorBargeIn"><span class="type-signature"></span>supervisorBargeIn<span class="signature">(call)</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>call</code></td> <td class="type"> <span class="param-type"><a href="PhoneCall.html">PhoneCall</a></span> </td> <td class="description last">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#line1010">line 1010</a> </li></ul></dd> </dl> <h4 class="name" id="supervisorDisconnect"><span class="type-signature"></span>supervisorDisconnect<span class="signature">(call)</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>call</code></td> <td class="type"> <span class="param-type"><a href="PhoneCall.html">PhoneCall</a></span> </td> <td class="description last">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#line1002">line 1002</a> </li></ul></dd> </dl> <h4 class="name" id="swap"><span class="type-signature"></span>swap<span class="signature">(call1, call2)</span><span class="type-signature"> &rarr; {Promise.&lt;<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#line904">line 904</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.&lt;<a href="HoldToggleResult.html">HoldToggleResult</a>></span> </dd> </dl> <h4 class="name" id="unmute"><span class="type-signature"></span>unmute<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="MuteToggleResult.html">MuteToggleResult</a>>}</span></h4> <div class="description"> Unmute call </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#line847">line 847</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.&lt;<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#line975">line 975</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="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="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="CapabilitiesResult.html">CapabilitiesResult</a></li><li><a href="Contact.html">Contact</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="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="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></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.4</a> on Thu Dec 21 2023 10:30:42 GMT-0800 (Pacific Standard Time) </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> </html>