Jump to: navigation, search
(Update with the copy of version: 8.5.2DRAFT)
(Update with the copy of version: 8.5.2DRAFT)
 
Line 1: Line 1:
−
= Voice Namespace=
+
 
 +
=Voice Namespace=
 
__TOC__
 
__TOC__
 
==Methods==
 
==Methods==
 
The Voice namespace includes the following methods:
 
The Voice namespace includes the following methods:
 +
* [[VoiceNamespace#answer|answer]]
 
* [[VoiceNamespace#dial|dial]]
 
* [[VoiceNamespace#dial|dial]]
 +
* [[VoiceNamespace#hangUp|hangUp]]
 +
* [[VoiceNamespace#hold|hold]]
 +
* [[VoiceNamespace#resume|resume]]
 
* [[VoiceNamespace#pauseCallRecording|pauseCallRecording]]
 
* [[VoiceNamespace#pauseCallRecording|pauseCallRecording]]
 
* [[VoiceNamespace#resumeCallRecording|resumeCallRecording]]
 
* [[VoiceNamespace#resumeCallRecording|resumeCallRecording]]
 
* [[VoiceNamespace#startCallRecording|startCallRecording]]
 
* [[VoiceNamespace#startCallRecording|startCallRecording]]
 
* [[VoiceNamespace#stopCallRecording|stopCallRecording]]
 
* [[VoiceNamespace#stopCallRecording|stopCallRecording]]
 +
* [[VoiceNamespace#isMicrophoneMute|isMicrophoneMute]]
 +
* [[VoiceNamespace#muteMicrophone|muteMicrophone]]
 +
* [[VoiceNamespace#unmuteMicrophone|unmuteMicrophone]]
 +
* [[VoiceNamespace#isSpeakerMute|isSpeakerMute]]
 +
* [[VoiceNamespace#muteSpeaker|muteSpeaker]]
 +
* [[VoiceNamespace#unmuteSpeaker|unmuteSpeaker]]
 +
 +
 +
===answer===
 +
 +
{|
 +
|-
 +
!|Signature
 +
|| answer('interactionId')
 +
|-
 +
!|Description
 +
||Answers the incoming call.
 +
|-
 +
!|Parameters
 +
||
 +
{|
 +
|-
 +
!|Name
 +
!|Type
 +
!|Argument
 +
!|Description
 +
|-
 +
||interaction
 +
||string
 +
|| 
 +
 +
||The interaction identifier
 +
|}
 +
|}
  
 
===dial===
 
===dial===
 +
{|! Signature|  dial(''destination'', ''userData'')! Description| Calls the destination in the same way Workspace Web Edition calls the destination from Team Communicator.! Parameters|
 +
{|
 +
|-
 +
!|Name
 +
!|Type
 +
!|Argument
 +
!|Description
 +
|-
 +
||destination
 +
||string
 +
|| 
 +
 +
||The call destination number.
 +
|-
 +
||userData
 +
||object
 +
|| 
 +
 +
||The attached user data key/value object that is updated with each interaction event.
 +
|}
 +
 +
===hangUp===
 +
 
{|
 
{|
−
! Signature
 
−
| <static> dial(''destination'', ''userData'')
 
 
|-
 
|-
−
! Description
+
!|Signature
−
| Calls the destination in the same way Workspace Web Edition calls the destination from Team Communicator. This methods supports caller ID and the [[Documentation:HTCC:IWWDep:Intercommunication|routing-based intercommunication features]].
+
|| hangUp('interactionId')
 
|-
 
|-
−
! Parameters
+
!|Description
−
|
+
||Releases the incoming call.
 +
|-
 +
!|Parameters
 +
||
 
{|
 
{|
−
! Name
 
−
! Type
 
−
! Argument
 
−
! Description
 
 
|-
 
|-
−
| destination
+
!|Name
−
| string
+
!|Type
−
|
+
!|Argument
−
| The call destination number.
+
!|Description
 
|-
 
|-
−
| userData
+
||interaction
−
| object
+
||string
−
| <optional>
+
|| 
−
| The attached user data key/value object that is updated with each interaction event.
+
 
 +
||The interaction identifier
 
|}
 
|}
 
|}
 
|}
  
−
===pauseCallRecording===
+
 
 +
===hold===
 +
 
 +
{|
 +
|-
 +
!|Signature
 +
|| hold('interactionId')
 +
|-
 +
!|Description
 +
||Holds the incoming call.
 +
|-
 +
!|Parameters
 +
||
 +
{|
 +
|-
 +
!|Name
 +
!|Type
 +
!|Argument
 +
!|Description
 +
|-
 +
||interaction
 +
||string
 +
|| 
 +
 
 +
||The interaction identifier
 +
|}
 +
|}
 +
 
 +
 
 +
===resume===
 +
 
 
{|
 
{|
−
! Signature
 
−
| <static> pauseCallRecording(''interactionId'')
 
 
|-
 
|-
−
! Description
+
!|Signature
−
| Pauses the call recording.
+
|| resume('interactionId')
 
|-
 
|-
−
! Parameters
+
!|Description
−
|
+
||Resumes the held call.
 +
|-
 +
!|Parameters
 +
||
 
{|
 
{|
−
! Name
 
−
! Type
 
−
! Description
 
 
|-
 
|-
−
| interactionId
+
!|Name
−
| string
+
!|Type
−
| The unique identifier for the interaction.
+
!|Argument
 +
!|Description
 +
|-
 +
||interaction
 +
||string
 +
|| 
 +
 
 +
||The interaction identifier
 
|}
 
|}
 
|}
 
|}
 +
 +
 +
 +
===pauseCallRecording===
 +
{|! Signature|  pauseCallRecording(''interactionId'')! Description| Pauses the call recording.! Parameters|
 +
{|
 +
|-
 +
!|Name
 +
!|Type
 +
!|Description
 +
|-
 +
||interactionId
 +
||string
 +
||The unique identifier for the interaction.
 +
|}
 +
  
 
===resumeCallRecording===
 
===resumeCallRecording===
 +
{|! Signature|  resumeCallRecording(''interactionId'')! Description| Resumes the call recording.! Parameters|
 
{|
 
{|
−
! Signature
 
−
| <static> resumeCallRecording(''interactionId'')
 
 
|-
 
|-
−
! Description
+
!|Name
−
| Resumes the call recording.
+
!|Type
 +
!|Description
 
|-
 
|-
−
! Parameters
+
||interactionId
−
|
+
||string
 +
||The unique identifier for the interaction.
 +
|}
 +
 
 +
 
 +
===startCallRecording===
 +
{|! Signature|  startCallRecording(''interactionId'')! Description| Starts the call recording.! Parameters|
 
{|
 
{|
−
! Name
 
−
! Type
 
−
! Description
 
 
|-
 
|-
−
| interactionId
+
!|Name
−
| string
+
!|Type
−
| The unique identifier for the interaction.
+
!|Description
 +
|-
 +
||interactionId
 +
||string
 +
||The unique identifier for the interaction.
 
|}
 
|}
 +
 +
 +
===stopCallRecording===
 +
{|! Signature|  stopCallRecording(''interactionId'')! Description| Stops the call recording.! Parameters|
 +
{|
 +
|-
 +
!|Name
 +
!|Type
 +
!|Description
 +
|-
 +
||interactionId
 +
||string
 +
||The unique identifier for the interaction.
 
|}
 
|}
  
−
===startCallRecording===
+
 
 +
===isMicrophoneMute===
 +
 
 
{|
 
{|
−
! Signature
 
−
| <static> startCallRecording(''interactionId'')
 
 
|-
 
|-
−
! Description
+
!|Signature
−
| Starts the call recording.
+
|| isMicrophoneMute()
 +
|-
 +
!|Description
 +
||Get the mute state of the microphone of the SIP Endpoint.
 
|-
 
|-
−
! Parameters
+
!|Parameters
−
|
+
||None.
 +
|}
 +
 
 +
 
 +
===muteMicrophone===
 +
 
 
{|
 
{|
−
! Name
 
−
! Type
 
−
! Description
 
 
|-
 
|-
−
| interactionId
+
!|Signature
−
| string
+
|| muteMicrophone()
−
| The unique identifier for the interaction.
+
|-
 +
!|Description
 +
||Mute the microphone of the SIP Endpoint.
 +
|-
 +
!|Parameters
 +
||None.
 
|}
 
|}
 +
 +
 +
===unmuteMicrophone===
 +
 +
{|
 +
|-
 +
!|Signature
 +
|| unmuteMicrophone())
 +
|-
 +
!|Description
 +
||Unmute the microphone of the SIP Endpoint.
 +
|-
 +
!|Parameters
 +
||None.
 
|}
 
|}
  
−
===stopCallRecording===
+
 
 +
===isSpeakerMute===
 +
 
 
{|
 
{|
−
! Signature
 
−
| <static> stopCallRecording(''interactionId'')
 
 
|-
 
|-
−
! Description
+
!|Signature
−
| Stops the call recording.
+
|| isSpeakerMute()
 
|-
 
|-
−
! Parameters
+
!|Description
−
|
+
||Get the mute state of the speaker of the SIP Endpoint.
 +
|-
 +
!|Parameters
 +
||None.
 +
|}
 +
 
 +
 
 +
===muteSpeaker===
 +
 
 
{|
 
{|
−
! Name
 
−
! Type
 
−
! Description
 
 
|-
 
|-
−
| interactionId
+
!|Signature
−
| string
+
|| muteSpeaker()
−
| The unique identifier for the interaction.
+
|-
 +
!|Description
 +
||Mute the speaker of the SIP Endpoint.
 +
|-
 +
!|Parameters
 +
||None.
 
|}
 
|}
 +
 +
 +
===unmuteSpeaker===
 +
 +
{|
 +
|-
 +
!|Signature
 +
|| unmuteSpeaker())
 +
|-
 +
!|Description
 +
||Unmute the speaker of the SIP Endpoint.
 +
|-
 +
!|Parameters
 +
||None.
 
|}
 
|}
  
  
 
[[Category:V:HTCC:8.5.2]]
 
[[Category:V:HTCC:8.5.2]]

Latest revision as of 17:54, February 23, 2018

Voice Namespace

Methods

The Voice namespace includes the following methods:


answer

Signature answer('interactionId')
Description Answers the incoming call.
Parameters
Name Type Argument Description
interaction string   The interaction identifier

dial

Name Type Argument Description
destination string   The call destination number.
userData object   The attached user data key/value object that is updated with each interaction event.

hangUp

Signature hangUp('interactionId')
Description Releases the incoming call.
Parameters
Name Type Argument Description
interaction string   The interaction identifier


hold

Signature hold('interactionId')
Description Holds the incoming call.
Parameters
Name Type Argument Description
interaction string   The interaction identifier


resume

Signature resume('interactionId')
Description Resumes the held call.
Parameters
Name Type Argument Description
interaction string   The interaction identifier


pauseCallRecording

Name Type Description
interactionId string The unique identifier for the interaction.


resumeCallRecording

Name Type Description
interactionId string The unique identifier for the interaction.


startCallRecording

Name Type Description
interactionId string The unique identifier for the interaction.


stopCallRecording

Name Type Description
interactionId string The unique identifier for the interaction.


isMicrophoneMute

Signature isMicrophoneMute()
Description Get the mute state of the microphone of the SIP Endpoint.
Parameters None.


muteMicrophone

Signature muteMicrophone()
Description Mute the microphone of the SIP Endpoint.
Parameters None.


unmuteMicrophone

Signature unmuteMicrophone())
Description Unmute the microphone of the SIP Endpoint.
Parameters None.


isSpeakerMute

Signature isSpeakerMute()
Description Get the mute state of the speaker of the SIP Endpoint.
Parameters None.


muteSpeaker

Signature muteSpeaker()
Description Mute the speaker of the SIP Endpoint.
Parameters None.


unmuteSpeaker

Signature unmuteSpeaker())
Description Unmute the speaker of the SIP Endpoint.
Parameters None.
This page was last edited on February 23, 2018, at 17:54.
Comments or questions about this documentation? Contact us for support!