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

From Genesys Documentation
Jump to: navigation, search
(Published)
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 78: Line 79:
 
{{!}}{{!}}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.
 
{{!}}}
 
{{!}}}
 +
 +
===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===

Revision as of 08:00, January 20, 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 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.

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 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.
Retrieved from "https://all.docs.genesys.com/PEC-Developer/Current/SCAPI/VoiceNamespace (2025-07-23 02:21:37)"
Comments or questions about this documentation? Contact us for support!