Jump to: navigation, search
Line 12: Line 12:
 
* [[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]]
  
  
Line 230: Line 236:
 
|}
 
|}
  
 +
===isMicrophoneMute===
 +
 +
{{Chgbar_open}}
 +
{|
 +
! Signature
 +
| <static> isMicrophoneMute()
 +
|-
 +
! Description
 +
| Get the mute state of the microphone of the SIP Endpoint.
 +
|-
 +
! Parameters
 +
| None.
 +
|}
 +
{{Chgbar_close}}
 +
 +
===muteMicrophone===
 +
 +
{{Chgbar_open}}
 +
{|
 +
! Signature
 +
| <static> muteMicrophone()
 +
|-
 +
! Description
 +
| Mute the microphone of the SIP Endpoint.
 +
|-
 +
! Parameters
 +
| None.
 +
|}
 +
{{Chgbar_close}}
 +
 +
===unmuteMicrophone===
 +
 +
{{Chgbar_open}}
 +
{|
 +
! Signature
 +
| <static> unmuteMicrophone())
 +
|-
 +
! Description
 +
| Unmute the microphone of the SIP Endpoint.
 +
|-
 +
! Parameters
 +
| None.
 +
|}
 +
{{Chgbar_close}}
 +
 +
===isSpeakerMute===
 +
 +
{{Chgbar_open}}
 +
{|
 +
! Signature
 +
| <static> isSpeakerMute()
 +
|-
 +
! Description
 +
| Get the mute state of the speaker of the SIP Endpoint.
 +
|-
 +
! Parameters
 +
| None.
 +
|}
 +
{{Chgbar_close}}
 +
 +
===muteSpeaker===
 +
 +
{{Chgbar_open}}
 +
{|
 +
! Signature
 +
| <static> muteSpeaker()
 +
|-
 +
! Description
 +
| Mute the speaker of the SIP Endpoint.
 +
|-
 +
! Parameters
 +
| None.
 +
|}
 +
{{Chgbar_close}}
 +
 +
===unmuteSpeaker===
 +
 +
{{Chgbar_open}}
 +
{|
 +
! Signature
 +
| <static> unmuteSpeaker())
 +
|-
 +
! Description
 +
| Unmute the speaker of the SIP Endpoint.
 +
|-
 +
! Parameters
 +
| None.
 +
|}
 +
{{Chgbar_close}}
  
 
[[Category:V:HTCC:8.5.2DRAFT]]
 
[[Category:V:HTCC:8.5.2DRAFT]]

Revision as of 15:32, February 7, 2018

Voice Namespace

Methods

The Voice namespace includes the following methods:


answer

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

dial

Signature <static> 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 <optional> The attached user data key/value object that is updated with each interaction event.

hangUp

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

hold

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

resume

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


pauseCallRecording

Signature <static> pauseCallRecording(interactionId)
Description Pauses the call recording.
Parameters
Name Type Description
interactionId string The unique identifier for the interaction.

resumeCallRecording

Signature <static> resumeCallRecording(interactionId)
Description Resumes the call recording.
Parameters
Name Type Description
interactionId string The unique identifier for the interaction.

startCallRecording

Signature <static> startCallRecording(interactionId)
Description Starts the call recording.
Parameters
Name Type Description
interactionId string The unique identifier for the interaction.

stopCallRecording

Signature <static> stopCallRecording(interactionId)
Description Stops the call recording.
Parameters
Name Type Description
interactionId string The unique identifier for the interaction.

isMicrophoneMute

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

muteMicrophone

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

unmuteMicrophone

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

isSpeakerMute

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

muteSpeaker

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

unmuteSpeaker

Signature <static> unmuteSpeaker())
Description Unmute the speaker of the SIP Endpoint.
Parameters None.
Comments or questions about this documentation? Contact us for support!