(Created target blank page For Version: HTCC:9.0.0DRAFT) |
|||
Line 1: | Line 1: | ||
− | + | =Voice Namespace= | |
+ | {{NoteFormat|The content on this page is no longer updated. To find the latest content, go to [https://all.docs.genesys.com/PEC-Developer/Current/SCAPI/VoiceNamespace Voice namespace].}} | ||
+ | __TOC__ | ||
+ | ==Methods== | ||
+ | The Voice namespace includes the following methods: | ||
+ | * [[VoiceNamespace#answer|answer]] | ||
+ | * [[VoiceNamespace#dial|dial]] | ||
+ | * [[VoiceNamespace#hangUp|hangUp]] | ||
+ | * [[VoiceNamespace#hold|hold]] | ||
+ | * [[VoiceNamespace#resume|resume]] | ||
+ | * [[VoiceNamespace#pauseCallRecording|pauseCallRecording]] | ||
+ | * [[VoiceNamespace#resumeCallRecording|resumeCallRecording]] | ||
+ | * [[VoiceNamespace#startCallRecording|startCallRecording]] | ||
+ | * [[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=== | ||
+ | {|! 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. | ||
+ | |} | ||
+ | |||
+ | |||
+ | [[Category:V:HTCC:9.0.0DRAFT]] |
Latest revision as of 17:02, February 1, 2022
Voice Namespace
Important
The content on this page is no longer updated. To find the latest content, go to Voice namespace.Contents
Methods
The Voice namespace includes the following methods:
- answer
- dial
- hangUp
- hold
- resume
- pauseCallRecording
- resumeCallRecording
- startCallRecording
- stopCallRecording
- isMicrophoneMute
- muteMicrophone
- unmuteMicrophone
- isSpeakerMute
- muteSpeaker
- unmuteSpeaker
answer
Signature | answer('interactionId') | ||||||||
---|---|---|---|---|---|---|---|---|---|
Description | Answers the incoming call. | ||||||||
Parameters |
|
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 |
|
hold
Signature | hold('interactionId') | ||||||||
---|---|---|---|---|---|---|---|---|---|
Description | Holds the incoming call. | ||||||||
Parameters |
|
resume
Signature | resume('interactionId') | ||||||||
---|---|---|---|---|---|---|---|---|---|
Description | Resumes the held call. | ||||||||
Parameters |
|
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 1, 2022, at 17:02.
Comments or questions about this documentation? Contact us for support!