Difference between revisions of "PEC-Developer/Current/SCAPI/VoiceNamespace"
From Genesys Documentation
m (Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2") |
(Published) |
||
| Line 255: | Line 255: | ||
{{!}}- | {{!}}- | ||
!{{!}}Signature | !{{!}}Signature | ||
| − | {{!}}{{!}} unmuteMicrophone( | + | {{!}}{{!}} unmuteMicrophone() |
{{!}}- | {{!}}- | ||
!{{!}}Description | !{{!}}Description | ||
| Line 300: | Line 300: | ||
{{!}}- | {{!}}- | ||
!{{!}}Signature | !{{!}}Signature | ||
| − | {{!}}{{!}} unmuteSpeaker( | + | {{!}}{{!}} unmuteSpeaker() |
{{!}}- | {{!}}- | ||
!{{!}}Description | !{{!}}Description | ||
Revision as of 14:02, March 2, 2022
Contents
Learn about the Voice namespace methods in the Service Client API.
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. |
Comments or questions about this documentation? Contact us for support!