From d01c8ed845dad53d4bfa1a3e56ec745aec97e0a4 Mon Sep 17 00:00:00 2001 From: RalfNikolai <42033366+RalfNikolai@users.noreply.github.com> Date: Tue, 29 Nov 2022 20:38:00 +0100 Subject: [PATCH] Update README.md adopted to the new and extended nodes --- .../vier-cognitive-voice-gateway/README.md | 131 ++++++++++++++++-- 1 file changed, 123 insertions(+), 8 deletions(-) diff --git a/extensions/vier-cognitive-voice-gateway/README.md b/extensions/vier-cognitive-voice-gateway/README.md index c7780186..cfd3d66a 100644 --- a/extensions/vier-cognitive-voice-gateway/README.md +++ b/extensions/vier-cognitive-voice-gateway/README.md @@ -1,9 +1,9 @@ # VIER Cognitive Voice Gateway -Enable phone bots with VIER Cognitive Voice Gateway (CVG). +Enable phone bots with VIER Cognitive Voice Gateway (CVG) and integration in various contact centers. This extension needs -* an account at VIER Cognitive Voice Gateway +* an account at VIER Cognitive Voice Gateway (in case you need an account please contact support@vier.ai) * a link between the project in CVG and the endpoint in Cognigy to be set up in CVG. See https://cognitivevoice.io/docs/conversational-ai/conversational-ai-cognigy.html for further information. @@ -100,10 +100,78 @@ The audio file is subject to caching, which means repeated use of the same URL https://url.to.audiofile.com/audio/prerecorded.wav - Barge In + Allow the speaker to interrupt the audio file by speaking If checked, the playing of the audio file can be interrupted by the speaker ✔️ + + Allow the caller to interrupt the audio file by pressing keys + If checked, the playing of the audio file can be interrupted by pressing keys + ✔️ + + + Fallback text + Text to be announced when the audio file cannot be played. + Welcome at VIER! + + + + + +## Node: Set Inactivity Timeout + +> Start inactivity detection with a specified timeout. + +The automatic inactivity timeout in the CVG project settings must be disabled for this feature to be available. + + +### Arguments + + + + + + + + + + + + + + + +
NameDescriptionExample
Enable or disable the timerCheck this option to enable the inactivity timer, uncheck it to disable the timer. If checked a timeout (in seconds) has to be entered.Disabled
+ +## Node: Set Speech-to-Text Service + +> Sets the Speech-to-Text Service for transcription of voice input + +### Arguments + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionExample
Language*The language to be used for Speech-to-Textde-DE
Speech-To-Text ServiceOne of the following Speech-to-Text Services: 'GOOGLE', 'IBM', 'MICROSOFT' or set a service via profile token.Microsoft
Speech-To-Text Service FallbackFallback if main Speech-to-Text Service is not available. One of the following Speech-to-Text Services: 'GOOGLE', 'IBM', 'MICROSOFT' or set a service via profile token.Google
@@ -263,7 +331,7 @@ The audio file is subject to caching, which means repeated use of the same URL - Destination Number + Destination Phone Number The phone number to forward the call to. Must be in +E.164 format or a SIP address. +4921123456789 or sip:+4921123456789@sip.cognitivevoice.io @@ -287,6 +355,16 @@ The audio file is subject to caching, which means repeated use of the same URL SIP headers that can be attached to the request. Headers need to be in the form of [key: string]: [string]. Keys need to be prefixed with a x-. Due to limitations, only 128 bytes of data will be accepted. Any SIP proxy on the path to the system, that is supposed to read the information, can alter or drop headers { "x-some-header": ["some", "data"] } + + Custom Data + Custom data that is attached to the dialog + Any valid JSON data consisting of key value pairs where the value is a string + + + Whispering Announcement + Text that should be announced to the agent the call is transfered to before the call parties are connected + Next call: Flight cancelation + Quit Flow Wether the flow should be terminated after this node did execute @@ -300,9 +378,9 @@ The audio file is subject to caching, which means repeated use of the same URL -## Node: Bridge Call +## Node: Forward Call to a Contact Center -> Bridges the call to a different destination for agent assistance. +> Forwards the call to a contact center destination for agent assistance. The called number is constructed by appending a random n-digit number to `Head Number` (where n ist the `Extension Length`). After a successful bridge, the bot will not receive further messages and will not be able to send any commands. Recordings will be stopped automatically if there are any running. @@ -318,7 +396,7 @@ After a successful bridge, the bot will not receive further messages and will no - Head Number + Phone Number Prefix The base phone number that is used to construct the complete phone number. Needs to be in +E.164 format +49721123456 @@ -347,6 +425,16 @@ After a successful bridge, the bot will not receive further messages and will no SIP headers that can be attached to the request. Headers need to be in the form of [key: string]: [string]. Keys need to be prefixed with a x-. Due to limitations, only 128 bytes of data will be accepted. Any SIP proxy on the path to the system, that is supposed to read the information, can alter or drop headers { "x-some-header": ["some", "data"] } + + Custom Data + Custom data that is attached to the dialog + Any valid JSON data consisting of key value pairs where the value is a string + + + Whispering Announcement + Text that should be announced to the agent the call is transfered to before the call parties are connected + Next call: Flight cancelation + Quit Flow Wether the flow should be terminated after this node did execute @@ -360,9 +448,36 @@ After a successful bridge, the bot will not receive further messages and will no +## Node: Check Call Forwarding Result + +> Check result after a call has been forwarded. Enables fallback handling if call couldn't be forwarded successfully. + +### Arguments +None. + ## Node: Terminate Call > Hangs up the call. ### Arguments -*None* + + + + + + + + + + + + + + + + + + + + +
NameDescriptionExample
Quit FlowWether the flow should be terminated after this node did execute✔️
Custom DataCustom data that is attached to the dialogAny valid JSON data consisting of key value pairs where the value is a string