PEC-Developer/Current/SCAPI/VoiceNamespace - Revision history

WikiSysop at 13:44, February 22, 2023

2023-02-22T13:44:40Z

Show changes

WikiSysop at 08:00, January 20, 2023

2023-01-20T08:00:45Z

Jumunn: Published

2022-03-02T14:02:21Z

Published

WikiSysop: Text replacement - "\|Platform=([^\|])GenesysEngage-onpremises([\|])" to "|Platform=$1GenesysEngage-cloud$2"

2020-07-25T02:30:57Z

Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|])PureEngage([\|])" to "|Platform=$1GenesysEngage-onpremises$2"

2020-07-15T11:46:14Z

Text replacement - "\|Platforms?=([^\|]*)PureEngage([\|]*)" to "|Platform=$1GenesysEngage-onpremises$2"

Jerickso: Published

2020-06-08T18:55:30Z

Published

New page

{{Article
|Standalone=No
|ComingSoon=No
|DisplayName=Voice namespace
|Platform=PureEngage
|TocName=Voice namespace
|Context=Learn about the Voice namespace methods in the Service Client API.
|Section={{Section
|sectionHeading=Methods
|Media=No
|anchor=Methods
|alignment=Vertical
|structuredtext=
The Voice namespace includes the following methods:
* {{Link-SomewhereInThisManual|topic=VoiceNamespace|anchor=answer|display text=answer}}
* {{Link-SomewhereInThisManual|topic=VoiceNamespace|anchor=dial|display text=dial}}
* {{Link-SomewhereInThisManual|topic=VoiceNamespace|anchor=hangUp|display text=hangUp}}
* {{Link-SomewhereInThisManual|topic=VoiceNamespace|anchor=hold|display text=hold}}
* {{Link-SomewhereInThisManual|topic=VoiceNamespace|anchor=resume|display text=resume}}
* {{Link-SomewhereInThisManual|topic=VoiceNamespace|anchor=pauseCallRecording|display text=pauseCallRecording}}
* {{Link-SomewhereInThisManual|topic=VoiceNamespace|anchor=resumeCallRecording|display text=resumeCallRecording}}
* {{Link-SomewhereInThisManual|topic=VoiceNamespace|anchor=startCallRecording|display text=startCallRecording}}
* {{Link-SomewhereInThisManual|topic=VoiceNamespace|anchor=stopCallRecording|display text=stopCallRecording}}
* {{Link-SomewhereInThisManual|topic=VoiceNamespace|anchor=isMicrophoneMute|display text=isMicrophoneMute}}
* {{Link-SomewhereInThisManual|topic=VoiceNamespace|anchor=muteMicrophone|display text=muteMicrophone}}
* {{Link-SomewhereInThisManual|topic=VoiceNamespace|anchor=unmuteMicrophone|display text=unmuteMicrophone}}
* {{Link-SomewhereInThisManual|topic=VoiceNamespace|anchor=isSpeakerMute|display text=isSpeakerMute}}
* {{Link-SomewhereInThisManual|topic=VoiceNamespace|anchor=muteSpeaker|display text=muteSpeaker}}
* {{Link-SomewhereInThisManual|topic=VoiceNamespace|anchor=unmuteSpeaker|display text=unmuteSpeaker}}

===answer===

{{{!}}
{{!}}-
!{{!}}Signature
{{!}}{{!}} answer('interactionId')
{{!}}-
!{{!}}Description
{{!}}{{!}}Answers the incoming call.
{{!}}-
!{{!}}Parameters
{{!}}{{!}}
{{{!}}
{{!}}-
!{{!}}Name
!{{!}}Type
!{{!}}Argument
!{{!}}Description
{{!}}-
{{!}}{{!}}interaction
{{!}}{{!}}string
{{!}}{{!}}

{{!}}{{!}}The interaction identifier
{{!}}}
{{!}}}

===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
{{!}}{{!}} 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===
{{{!}}! Signature{{!}} pauseCallRecording(''interactionId'')! Description{{!}} Pauses the call recording.! Parameters{{!}}
{{{!}}
{{!}}-
!{{!}}Name
!{{!}}Type
!{{!}}Description
{{!}}-
{{!}}{{!}}interactionId
{{!}}{{!}}string
{{!}}{{!}}The unique identifier for the interaction.
{{!}}}

===resumeCallRecording===
{{{!}}! Signature{{!}} resumeCallRecording(''interactionId'')! Description{{!}} Resumes the call recording.! Parameters{{!}}
{{{!}}
{{!}}-
!{{!}}Name
!{{!}}Type
!{{!}}Description
{{!}}-
{{!}}{{!}}interactionId
{{!}}{{!}}string
{{!}}{{!}}The unique identifier for the interaction.
{{!}}}

===startCallRecording===
{{{!}}! Signature{{!}} startCallRecording(''interactionId'')! Description{{!}} Starts the call recording.! Parameters{{!}}
{{{!}}
{{!}}-
!{{!}}Name
!{{!}}Type
!{{!}}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.
{{!}}}

===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.
{{!}}}

|fullwidth=No
|Status=No
}}
}}

@@ Line 15: / Line 15: @@
 * {{Link-SomewhereInThisManual|topic=VoiceNamespace|anchor=answer|display text=answer}}
 * {{Link-SomewhereInThisManual|topic=VoiceNamespace|anchor=dial|display text=dial}}
 * {{Link-SomewhereInThisManual|topic=VoiceNamespace|anchor=hangUp|display text=hangUp}}
 * {{Link-SomewhereInThisManual|topic=VoiceNamespace|anchor=hold|display text=hold}}
@@ Line 78: / Line 79: @@
 {{!}}{{!}}The attached user data key/value object that is updated with each interaction event.
 {{!}}}
 ===hangUp===

@@ Line 255: / Line 255: @@
 {{!}}-
 !{{!}}Signature
-{{!}}{{!}} unmuteMicrophone())
+{{!}}{{!}} unmuteMicrophone()
 {{!}}-
 !{{!}}Description
@@ Line 300: / Line 300: @@
 {{!}}-
 !{{!}}Signature
-{{!}}{{!}} unmuteSpeaker())
+{{!}}{{!}} unmuteSpeaker()
 {{!}}-
 !{{!}}Description

@@ Line 3: / Line 3: @@
 |ComingSoon=No
 |DisplayName=Voice namespace
-|Platform=GenesysEngage-onpremises
+|Platform=GenesysEngage-cloud
 |TocName=Voice namespace
 |Context=Learn about the Voice namespace methods in the Service Client API.

PEC-Developer/Current/SCAPI/VoiceNamespace - Revision history

WikiSysop at 13:44, February 22, 2023

WikiSysop at 08:00, January 20, 2023

Jumunn: Published

WikiSysop: Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|]*)PureEngage([\|]*)" to "|Platform=$1GenesysEngage-onpremises$2"

Jerickso: Published

WikiSysop: Text replacement - "\|Platform=([^\|])GenesysEngage-onpremises([\|])" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|])PureEngage([\|])" to "|Platform=$1GenesysEngage-onpremises$2"