Difference between revisions of "PEC-Developer/Current/SCAPI/VoiceNamespace"

From Genesys Documentation
Jump to: navigation, search
m (Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2")
 
(2 intermediate revisions by 2 users not shown)
Line 15: Line 15:
 
* {{Link-SomewhereInThisManual|topic=VoiceNamespace|anchor=answer|display text=answer}}
 
* {{Link-SomewhereInThisManual|topic=VoiceNamespace|anchor=answer|display text=answer}}
 
* {{Link-SomewhereInThisManual|topic=VoiceNamespace|anchor=dial|display text=dial}}
 
* {{Link-SomewhereInThisManual|topic=VoiceNamespace|anchor=dial|display text=dial}}
 +
* {{Link-SomewhereInThisManual|topic=VoiceNamespace|anchor=dialEx|display text=dialEx}}
 
* {{Link-SomewhereInThisManual|topic=VoiceNamespace|anchor=hangUp|display text=hangUp}}
 
* {{Link-SomewhereInThisManual|topic=VoiceNamespace|anchor=hangUp|display text=hangUp}}
 
* {{Link-SomewhereInThisManual|topic=VoiceNamespace|anchor=hold|display text=hold}}
 
* {{Link-SomewhereInThisManual|topic=VoiceNamespace|anchor=hold|display text=hold}}
Line 35: Line 36:
 
{{!}}-
 
{{!}}-
 
!{{!}}Signature
 
!{{!}}Signature
−
{{!}}{{!}} answer('interactionId')
+
{{!}}{{!}} <static> answer('interactionId', succeeded, failed)
 
{{!}}-
 
{{!}}-
 
!{{!}}Description
 
!{{!}}Description
Line 49: Line 50:
 
!{{!}}Description
 
!{{!}}Description
 
{{!}}-
 
{{!}}-
−
{{!}}{{!}}interaction
+
{{!}}{{!}}interactionId
 
{{!}}{{!}}string
 
{{!}}{{!}}string
 
{{!}}{{!}} 
 
{{!}}{{!}} 
  
 
{{!}}{{!}}The interaction identifier
 
{{!}}{{!}}The interaction identifier
 +
{{!}}-
 +
{{!}}{{!}} succeeded
 +
{{!}}{{!}}function
 +
{{!}}{{!}} 
 +
 +
{{!}}{{!}}A function called when the operation succeeds.
 +
{{!}}-
 +
{{!}}{{!}} failed
 +
{{!}}{{!}}function
 +
{{!}}{{!}} 
 +
 +
{{!}}{{!}}A function called when the operation fails.
 
{{!}}}
 
{{!}}}
 
{{!}}}
 
{{!}}}
  
 
===dial===
 
===dial===
−
{{{!}}! Signature{{!}} dial(''destination'', ''userData'')! Description{{!}} Calls the destination in the same way Workspace Web Edition calls the destination from Team Communicator.! Parameters{{!}}
+
 
 +
{{{!}}
 +
{{!}}-
 +
!{{!}}Signature
 +
{{!}}{{!}} <static> dial(destination, userData, succeeded, failed)
 +
{{!}}-
 +
!{{!}}Description
 +
{{!}}{{!}}Calls the destination in the same way Workspace Web Edition calls the destination from Team Communicator.
 +
{{!}}-
 +
!{{!}}Parameters
 +
{{!}}{{!}}
 
{{{!}}
 
{{{!}}
 
{{!}}-
 
{{!}}-
Line 77: Line 100:
  
 
{{!}}{{!}}The attached user data key/value object that is updated with each interaction event.
 
{{!}}{{!}}The attached user data key/value object that is updated with each interaction event.
 +
{{!}}-
 +
{{!}}{{!}} succeeded
 +
{{!}}{{!}}function
 +
{{!}}{{!}} 
 +
 +
{{!}}{{!}}A function called when the operation succeeds.
 +
{{!}}-
 +
{{!}}{{!}} failed
 +
{{!}}{{!}}function
 +
{{!}}{{!}} 
 +
 +
{{!}}{{!}}A function called when the operation fails.
 +
{{!}}}
 +
{{!}}}
 +
 +
===dialEx===
 +
 +
{{{!}}
 +
{{!}}-
 +
!{{!}}Signature
 +
{{!}}{{!}} <static> dialEx(''destination'', ''userData'', ''extensions'', ''succeeded'', ''failed'')
 +
{{!}}-
 +
!{{!}}Description
 +
{{!}}{{!}}Calls the destination with the attached data and extensions.
 +
{{!}}-
 +
!{{!}}Parameters
 +
{{!}}{{!}}
 +
{{{!}}
 +
{{!}}-
 +
!{{!}}Name
 +
!{{!}}Type
 +
!{{!}}Argument
 +
!{{!}}Description
 +
{{!}}-
 +
{{!}}{{!}}destination
 +
{{!}}{{!}}string
 +
{{!}}{{!}} 
 +
 +
{{!}}{{!}}The call destination number.
 +
{{!}}-
 +
{{!}}{{!}}userData
 +
{{!}}{{!}}object
 +
{{!}}{{!}} 
 +
 +
{{!}}{{!}}The attached user data key/value object. Set an undefined or empty JSON object if you don't want to set any user data.
 +
{{!}}-
 +
{{!}}{{!}}extensions
 +
{{!}}{{!}}object
 +
{{!}}{{!}} 
 +
 +
{{!}}{{!}}The extensions key/value object. Set an undefined or empty JSON object if you don't want to set any extensions.
 +
{{!}}-
 +
{{!}}{{!}}succeeded
 +
{{!}}{{!}}function
 +
{{!}}{{!}} 
 +
 +
{{!}}{{!}}A function called when the operation succeeds.
 +
{{!}}-
 +
{{!}}{{!}}failed
 +
{{!}}{{!}}function
 +
{{!}}{{!}} 
 +
 +
{{!}}{{!}}A function called when the operation fails.
 +
{{!}}}
 
{{!}}}
 
{{!}}}
 +
  
 
===hangUp===
 
===hangUp===
Line 84: Line 172:
 
{{!}}-
 
{{!}}-
 
!{{!}}Signature
 
!{{!}}Signature
−
{{!}}{{!}} hangUp('interactionId')
+
{{!}}{{!}} <static> hangUp('interactionId', succeeded, failed)
 
{{!}}-
 
{{!}}-
 
!{{!}}Description
 
!{{!}}Description
Line 98: Line 186:
 
!{{!}}Description
 
!{{!}}Description
 
{{!}}-
 
{{!}}-
−
{{!}}{{!}}interaction
+
{{!}}{{!}}interactionId
 
{{!}}{{!}}string
 
{{!}}{{!}}string
 
{{!}}{{!}} 
 
{{!}}{{!}} 
  
 
{{!}}{{!}}The interaction identifier
 
{{!}}{{!}}The interaction identifier
 +
{{!}}-
 +
{{!}}{{!}} succeeded
 +
{{!}}{{!}}function
 +
{{!}}{{!}} 
 +
 +
{{!}}{{!}}A function called when the operation succeeds.
 +
{{!}}-
 +
{{!}}{{!}} failed
 +
{{!}}{{!}}function
 +
{{!}}{{!}} 
 +
 +
{{!}}{{!}}A function called when the operation fails.
 
{{!}}}
 
{{!}}}
 
{{!}}}
 
{{!}}}
Line 112: Line 212:
 
{{!}}-
 
{{!}}-
 
!{{!}}Signature
 
!{{!}}Signature
−
{{!}}{{!}} hold('interactionId')
+
{{!}}{{!}} <static> hold('interactionId', succeeded, failed)
 
{{!}}-
 
{{!}}-
 
!{{!}}Description
 
!{{!}}Description
Line 126: Line 226:
 
!{{!}}Description
 
!{{!}}Description
 
{{!}}-
 
{{!}}-
−
{{!}}{{!}}interaction
+
{{!}}{{!}}interactionId
 
{{!}}{{!}}string
 
{{!}}{{!}}string
 
{{!}}{{!}} 
 
{{!}}{{!}} 
  
 
{{!}}{{!}}The interaction identifier
 
{{!}}{{!}}The interaction identifier
 +
{{!}}-
 +
{{!}}{{!}} succeeded
 +
{{!}}{{!}}function
 +
{{!}}{{!}} 
 +
 +
{{!}}{{!}}A function called when the operation succeeds.
 +
{{!}}-
 +
{{!}}{{!}} failed
 +
{{!}}{{!}}function
 +
{{!}}{{!}} 
 +
 +
{{!}}{{!}}A function called when the operation fails.
 
{{!}}}
 
{{!}}}
 
{{!}}}
 
{{!}}}
Line 140: Line 252:
 
{{!}}-
 
{{!}}-
 
!{{!}}Signature
 
!{{!}}Signature
−
{{!}}{{!}} resume('interactionId')
+
{{!}}{{!}} <static> resume('interactionId', succeeded, failed)
 
{{!}}-
 
{{!}}-
 
!{{!}}Description
 
!{{!}}Description
Line 154: Line 266:
 
!{{!}}Description
 
!{{!}}Description
 
{{!}}-
 
{{!}}-
−
{{!}}{{!}}interaction
+
{{!}}{{!}}interactionId
 
{{!}}{{!}}string
 
{{!}}{{!}}string
 
{{!}}{{!}} 
 
{{!}}{{!}} 
  
 
{{!}}{{!}}The interaction identifier
 
{{!}}{{!}}The interaction identifier
 +
{{!}}-
 +
{{!}}{{!}} succeeded
 +
{{!}}{{!}}function
 +
{{!}}{{!}} 
 +
 +
{{!}}{{!}}A function called when the operation succeeds.
 +
{{!}}-
 +
{{!}}{{!}} failed
 +
{{!}}{{!}}function
 +
{{!}}{{!}} 
 +
 +
{{!}}{{!}}A function called when the operation fails.
 
{{!}}}
 
{{!}}}
 
{{!}}}
 
{{!}}}
Line 165: Line 289:
  
 
===pauseCallRecording===
 
===pauseCallRecording===
−
{{{!}}! Signature{{!}} pauseCallRecording(''interactionId'')! Description{{!}} Pauses the call recording.! Parameters{{!}}
+
{{{!}}
 +
{{!}}-
 +
!{{!}}Signature
 +
{{!}}{{!}} <static> pauseCallRecording('interactionId', succeeded, failed)
 +
{{!}}-
 +
!{{!}}Description
 +
{{!}}{{!}}Pause the call recording.
 +
{{!}}-
 +
!{{!}}Parameters
 +
{{!}}{{!}}
 
{{{!}}
 
{{{!}}
 
{{!}}-
 
{{!}}-
 
!{{!}}Name
 
!{{!}}Name
 
!{{!}}Type
 
!{{!}}Type
 +
!{{!}}Argument
 
!{{!}}Description
 
!{{!}}Description
 
{{!}}-
 
{{!}}-
 
{{!}}{{!}}interactionId
 
{{!}}{{!}}interactionId
 
{{!}}{{!}}string
 
{{!}}{{!}}string
−
{{!}}{{!}}The unique identifier for the interaction.
+
{{!}}{{!}} 
 +
 
 +
{{!}}{{!}}The interaction identifier
 +
{{!}}-
 +
{{!}}{{!}} succeeded
 +
{{!}}{{!}}function
 +
{{!}}{{!}} 
 +
 
 +
{{!}}{{!}}A function called when the operation succeeds.
 +
{{!}}-
 +
{{!}}{{!}} failed
 +
{{!}}{{!}}function
 +
{{!}}{{!}} 
 +
 
 +
{{!}}{{!}}A function called when the operation fails.
 +
{{!}}}
 
{{!}}}
 
{{!}}}
  
  
 
===resumeCallRecording===
 
===resumeCallRecording===
−
{{{!}}! Signature{{!}} resumeCallRecording(''interactionId'')! Description{{!}} Resumes the call recording.! Parameters{{!}}
+
{{{!}}
 +
{{!}}-
 +
!{{!}}Signature
 +
{{!}}{{!}} <static> resumeCallRecording('interactionId', succeeded, failed)
 +
{{!}}-
 +
!{{!}}Description
 +
{{!}}{{!}}Resumes the call recording.
 +
{{!}}-
 +
!{{!}}Parameters
 +
{{!}}{{!}}
 
{{{!}}
 
{{{!}}
 
{{!}}-
 
{{!}}-
 
!{{!}}Name
 
!{{!}}Name
 
!{{!}}Type
 
!{{!}}Type
 +
!{{!}}Argument
 
!{{!}}Description
 
!{{!}}Description
 
{{!}}-
 
{{!}}-
 
{{!}}{{!}}interactionId
 
{{!}}{{!}}interactionId
 
{{!}}{{!}}string
 
{{!}}{{!}}string
−
{{!}}{{!}}The unique identifier for the interaction.
+
{{!}}{{!}} 
 +
 
 +
{{!}}{{!}}The interaction identifier
 +
{{!}}-
 +
{{!}}{{!}} succeeded
 +
{{!}}{{!}}function
 +
{{!}}{{!}} 
 +
 
 +
{{!}}{{!}}A function called when the operation succeeds.
 +
{{!}}-
 +
{{!}}{{!}} failed
 +
{{!}}{{!}}function
 +
{{!}}{{!}} 
 +
 
 +
{{!}}{{!}}A function called when the operation fails.
 +
{{!}}}
 
{{!}}}
 
{{!}}}
  
  
 
===startCallRecording===
 
===startCallRecording===
−
{{{!}}! Signature{{!}} startCallRecording(''interactionId'')! Description{{!}} Starts the call recording.! Parameters{{!}}
+
{{{!}}
 +
{{!}}-
 +
!{{!}}Signature
 +
{{!}}{{!}} <static> startCallRecording('interactionId', succeeded, failed)
 +
{{!}}-
 +
!{{!}}Description
 +
{{!}}{{!}}Starts the call recording.
 +
{{!}}-
 +
!{{!}}Parameters
 +
{{!}}{{!}}
 
{{{!}}
 
{{{!}}
 
{{!}}-
 
{{!}}-
 
!{{!}}Name
 
!{{!}}Name
 
!{{!}}Type
 
!{{!}}Type
 +
!{{!}}Argument
 
!{{!}}Description
 
!{{!}}Description
 
{{!}}-
 
{{!}}-
 
{{!}}{{!}}interactionId
 
{{!}}{{!}}interactionId
 
{{!}}{{!}}string
 
{{!}}{{!}}string
−
{{!}}{{!}}The unique identifier for the interaction.
+
{{!}}{{!}} 
 +
 
 +
{{!}}{{!}}The interaction identifier
 +
{{!}}-
 +
{{!}}{{!}} succeeded
 +
{{!}}{{!}}function
 +
{{!}}{{!}} 
 +
 
 +
{{!}}{{!}}A function called when the operation succeeds.
 +
{{!}}-
 +
{{!}}{{!}} failed
 +
{{!}}{{!}}function
 +
{{!}}{{!}} 
 +
 
 +
{{!}}{{!}}A function called when the operation fails.
 +
{{!}}}
 
{{!}}}
 
{{!}}}
 +
  
  
 
===stopCallRecording===
 
===stopCallRecording===
−
{{{!}}! Signature{{!}} stopCallRecording(''interactionId'')! Description{{!}} Stops the call recording.! Parameters{{!}}
+
{{{!}}
 +
{{!}}-
 +
!{{!}}Signature
 +
{{!}}{{!}} <static> stopCallRecording('interactionId', succeeded, failed)
 +
{{!}}-
 +
!{{!}}Description
 +
{{!}}{{!}}Stops the call recording.
 +
{{!}}-
 +
!{{!}}Parameters
 +
{{!}}{{!}}
 
{{{!}}
 
{{{!}}
 
{{!}}-
 
{{!}}-
 
!{{!}}Name
 
!{{!}}Name
 
!{{!}}Type
 
!{{!}}Type
 +
!{{!}}Argument
 
!{{!}}Description
 
!{{!}}Description
 
{{!}}-
 
{{!}}-
 
{{!}}{{!}}interactionId
 
{{!}}{{!}}interactionId
 
{{!}}{{!}}string
 
{{!}}{{!}}string
−
{{!}}{{!}}The unique identifier for the interaction.
+
{{!}}{{!}} 
 +
 
 +
{{!}}{{!}}The interaction identifier
 +
{{!}}-
 +
{{!}}{{!}} succeeded
 +
{{!}}{{!}}function
 +
{{!}}{{!}} 
 +
 
 +
{{!}}{{!}}A function called when the operation succeeds.
 +
{{!}}-
 +
{{!}}{{!}} failed
 +
{{!}}{{!}}function
 +
{{!}}{{!}} 
 +
 
 +
{{!}}{{!}}A function called when the operation fails.
 +
{{!}}}
 
{{!}}}
 
{{!}}}
  
Line 225: Line 450:
 
{{!}}-
 
{{!}}-
 
!{{!}}Signature
 
!{{!}}Signature
−
{{!}}{{!}} isMicrophoneMute()
+
{{!}}{{!}} <static> isMicrophoneMute(succeeded, failed)
 
{{!}}-
 
{{!}}-
 
!{{!}}Description
 
!{{!}}Description
Line 231: Line 456:
 
{{!}}-
 
{{!}}-
 
!{{!}}Parameters
 
!{{!}}Parameters
−
{{!}}{{!}}None.
+
{{!}}{{!}}
 +
{{{!}}
 +
{{!}}-
 +
!{{!}}Name
 +
!{{!}}Type
 +
!{{!}}Argument
 +
!{{!}}Description
 +
{{!}}-
 +
{{!}}{{!}} succeeded
 +
{{!}}{{!}}function
 +
{{!}}{{!}} 
 +
 
 +
{{!}}{{!}}A function called when the operation succeeds.
 +
{{!}}-
 +
{{!}}{{!}} failed
 +
{{!}}{{!}}function
 +
{{!}}{{!}} 
 +
 
 +
{{!}}{{!}}A function called when the operation fails.
 +
{{!}}}
 
{{!}}}
 
{{!}}}
  
Line 240: Line 484:
 
{{!}}-
 
{{!}}-
 
!{{!}}Signature
 
!{{!}}Signature
−
{{!}}{{!}} muteMicrophone()
+
{{!}}{{!}} <static> muteMicrophone(succeeded, failed)
 
{{!}}-
 
{{!}}-
 
!{{!}}Description
 
!{{!}}Description
Line 246: Line 490:
 
{{!}}-
 
{{!}}-
 
!{{!}}Parameters
 
!{{!}}Parameters
−
{{!}}{{!}}None.
+
{{!}}{{!}}
 +
{{{!}}
 +
{{!}}-
 +
!{{!}}Name
 +
!{{!}}Type
 +
!{{!}}Argument
 +
!{{!}}Description
 +
{{!}}-
 +
{{!}}{{!}} succeeded
 +
{{!}}{{!}}function
 +
{{!}}{{!}} 
 +
 
 +
{{!}}{{!}}A function called when the operation succeeds.
 +
{{!}}-
 +
{{!}}{{!}} failed
 +
{{!}}{{!}}function
 +
{{!}}{{!}} 
 +
 
 +
{{!}}{{!}}A function called when the operation fails.
 +
{{!}}}
 
{{!}}}
 
{{!}}}
  
Line 255: Line 518:
 
{{!}}-
 
{{!}}-
 
!{{!}}Signature
 
!{{!}}Signature
−
{{!}}{{!}} unmuteMicrophone())
+
{{!}}{{!}} <static> unmuteMicrophone(succeeded, failed)
 
{{!}}-
 
{{!}}-
 
!{{!}}Description
 
!{{!}}Description
Line 261: Line 524:
 
{{!}}-
 
{{!}}-
 
!{{!}}Parameters
 
!{{!}}Parameters
−
{{!}}{{!}}None.
+
{{!}}{{!}}
 +
{{{!}}
 +
{{!}}-
 +
!{{!}}Name
 +
!{{!}}Type
 +
!{{!}}Argument
 +
!{{!}}Description
 +
{{!}}-
 +
{{!}}{{!}} succeeded
 +
{{!}}{{!}}function
 +
{{!}}{{!}} 
 +
 
 +
{{!}}{{!}}A function called when the operation succeeds.
 +
{{!}}-
 +
{{!}}{{!}} failed
 +
{{!}}{{!}}function
 +
{{!}}{{!}} 
 +
 
 +
{{!}}{{!}}A function called when the operation fails.
 +
{{!}}}
 
{{!}}}
 
{{!}}}
  
Line 270: Line 552:
 
{{!}}-
 
{{!}}-
 
!{{!}}Signature
 
!{{!}}Signature
−
{{!}}{{!}} isSpeakerMute()
+
{{!}}{{!}} <static> isSpeakerMute(succeeded, failed)
 
{{!}}-
 
{{!}}-
 
!{{!}}Description
 
!{{!}}Description
Line 276: Line 558:
 
{{!}}-
 
{{!}}-
 
!{{!}}Parameters
 
!{{!}}Parameters
−
{{!}}{{!}}None.
+
{{!}}{{!}}
 +
{{{!}}
 +
{{!}}-
 +
!{{!}}Name
 +
!{{!}}Type
 +
!{{!}}Argument
 +
!{{!}}Description
 +
{{!}}-
 +
{{!}}{{!}} succeeded
 +
{{!}}{{!}}function
 +
{{!}}{{!}} 
 +
 
 +
{{!}}{{!}}A function called when the operation succeeds.
 +
{{!}}-
 +
{{!}}{{!}} failed
 +
{{!}}{{!}}function
 +
{{!}}{{!}} 
 +
 
 +
{{!}}{{!}}A function called when the operation fails.
 +
{{!}}}
 
{{!}}}
 
{{!}}}
  
Line 285: Line 586:
 
{{!}}-
 
{{!}}-
 
!{{!}}Signature
 
!{{!}}Signature
−
{{!}}{{!}} muteSpeaker()
+
{{!}}{{!}} <static> muteSpeaker(succeeded, failed)
 
{{!}}-
 
{{!}}-
 
!{{!}}Description
 
!{{!}}Description
Line 291: Line 592:
 
{{!}}-
 
{{!}}-
 
!{{!}}Parameters
 
!{{!}}Parameters
−
{{!}}{{!}}None.
+
{{!}}{{!}}
 +
{{{!}}
 +
{{!}}-
 +
!{{!}}Name
 +
!{{!}}Type
 +
!{{!}}Argument
 +
!{{!}}Description
 +
{{!}}-
 +
{{!}}{{!}} succeeded
 +
{{!}}{{!}}function
 +
{{!}}{{!}} 
 +
 
 +
{{!}}{{!}}A function called when the operation succeeds.
 +
{{!}}-
 +
{{!}}{{!}} failed
 +
{{!}}{{!}}function
 +
{{!}}{{!}} 
 +
 
 +
{{!}}{{!}}A function called when the operation fails.
 +
{{!}}}
 
{{!}}}
 
{{!}}}
  
Line 300: Line 620:
 
{{!}}-
 
{{!}}-
 
!{{!}}Signature
 
!{{!}}Signature
−
{{!}}{{!}} unmuteSpeaker())
+
{{!}}{{!}} <static> unmuteSpeaker(succeeded, failed)
 
{{!}}-
 
{{!}}-
 
!{{!}}Description
 
!{{!}}Description
Line 306: Line 626:
 
{{!}}-
 
{{!}}-
 
!{{!}}Parameters
 
!{{!}}Parameters
−
{{!}}{{!}}None.
+
{{!}}{{!}}
 +
{{{!}}
 +
{{!}}-
 +
!{{!}}Name
 +
!{{!}}Type
 +
!{{!}}Argument
 +
!{{!}}Description
 +
{{!}}-
 +
{{!}}{{!}} succeeded
 +
{{!}}{{!}}function
 +
{{!}}{{!}} 
 +
 
 +
{{!}}{{!}}A function called when the operation succeeds.
 +
{{!}}-
 +
{{!}}{{!}} failed
 +
{{!}}{{!}}function
 +
{{!}}{{!}} 
 +
 
 +
{{!}}{{!}}A function called when the operation fails.
 +
{{!}}}
 
{{!}}}
 
{{!}}}
  

Latest revision as of 13:44, February 22, 2023

This topic is part of the manual Service Client API Reference for version Current of Developer.

Learn about the Voice namespace methods in the Service Client API.

Methods

The Voice namespace includes the following methods:


answer

Signature <static> answer('interactionId', succeeded, failed)
Description Answers the incoming call.
Parameters
Name Type Argument Description
interactionId string   The interaction identifier
succeeded function   A function called when the operation succeeds.
failed function   A function called when the operation fails.

dial

Signature <static> dial(destination, userData, succeeded, failed)
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.
succeeded function   A function called when the operation succeeds.
failed function   A function called when the operation fails.

dialEx

Signature <static> dialEx(destination, userData, extensions, succeeded, failed)
Description Calls the destination with the attached data and extensions.
Parameters
Name Type Argument Description
destination string   The call destination number.
userData object   The attached user data key/value object. Set an undefined or empty JSON object if you don't want to set any user data.
extensions object   The extensions key/value object. Set an undefined or empty JSON object if you don't want to set any extensions.
succeeded function   A function called when the operation succeeds.
failed function   A function called when the operation fails.


hangUp

Signature <static> hangUp('interactionId', succeeded, failed)
Description Releases the incoming call.
Parameters
Name Type Argument Description
interactionId string   The interaction identifier
succeeded function   A function called when the operation succeeds.
failed function   A function called when the operation fails.


hold

Signature <static> hold('interactionId', succeeded, failed)
Description Holds the incoming call.
Parameters
Name Type Argument Description
interactionId string   The interaction identifier
succeeded function   A function called when the operation succeeds.
failed function   A function called when the operation fails.


resume

Signature <static> resume('interactionId', succeeded, failed)
Description Resumes the held call.
Parameters
Name Type Argument Description
interactionId string   The interaction identifier
succeeded function   A function called when the operation succeeds.
failed function   A function called when the operation fails.


pauseCallRecording

Signature <static> pauseCallRecording('interactionId', succeeded, failed)
Description Pause the call recording.
Parameters
Name Type Argument Description
interactionId string   The interaction identifier
succeeded function   A function called when the operation succeeds.
failed function   A function called when the operation fails.


resumeCallRecording

Signature <static> resumeCallRecording('interactionId', succeeded, failed)
Description Resumes the call recording.
Parameters
Name Type Argument Description
interactionId string   The interaction identifier
succeeded function   A function called when the operation succeeds.
failed function   A function called when the operation fails.


startCallRecording

Signature <static> startCallRecording('interactionId', succeeded, failed)
Description Starts the call recording.
Parameters
Name Type Argument Description
interactionId string   The interaction identifier
succeeded function   A function called when the operation succeeds.
failed function   A function called when the operation fails.


stopCallRecording

Signature <static> stopCallRecording('interactionId', succeeded, failed)
Description Stops the call recording.
Parameters
Name Type Argument Description
interactionId string   The interaction identifier
succeeded function   A function called when the operation succeeds.
failed function   A function called when the operation fails.


isMicrophoneMute

Signature <static> isMicrophoneMute(succeeded, failed)
Description Get the mute state of the microphone of the SIP Endpoint.
Parameters
Name Type Argument Description
succeeded function   A function called when the operation succeeds.
failed function   A function called when the operation fails.


muteMicrophone

Signature <static> muteMicrophone(succeeded, failed)
Description Mute the microphone of the SIP Endpoint.
Parameters
Name Type Argument Description
succeeded function   A function called when the operation succeeds.
failed function   A function called when the operation fails.


unmuteMicrophone

Signature <static> unmuteMicrophone(succeeded, failed)
Description Unmute the microphone of the SIP Endpoint.
Parameters
Name Type Argument Description
succeeded function   A function called when the operation succeeds.
failed function   A function called when the operation fails.


isSpeakerMute

Signature <static> isSpeakerMute(succeeded, failed)
Description Get the mute state of the speaker of the SIP Endpoint.
Parameters
Name Type Argument Description
succeeded function   A function called when the operation succeeds.
failed function   A function called when the operation fails.


muteSpeaker

Signature <static> muteSpeaker(succeeded, failed)
Description Mute the speaker of the SIP Endpoint.
Parameters
Name Type Argument Description
succeeded function   A function called when the operation succeeds.
failed function   A function called when the operation fails.


unmuteSpeaker

Signature <static> unmuteSpeaker(succeeded, failed)
Description Unmute the speaker of the SIP Endpoint.
Parameters
Name Type Argument Description
succeeded function   A function called when the operation succeeds.
failed function   A function called when the operation fails.
Retrieved from "https://all.docs.genesys.com/PEC-Developer/Current/SCAPI/VoiceNamespace (2025-07-23 12:35:51)"
Comments or questions about this documentation? Contact us for support!