Anadm at 14:23, 26 March 2018

2018-03-26T14:23:01Z

Anadm at 14:32, 5 September 2017

2017-09-05T14:32:15Z

Anadm at 14:05, 29 August 2017

2017-08-29T14:05:44Z

Anadm: Created page with "{{DISPLAYTITLE: Announcements and User Interactive Voice Response IVR }} {{PAGE_HEADER}} {{Page_Menu_List_Help_AdminCenter_Feature}} ..."

2017-08-23T12:17:56Z

Created page with "{{DISPLAYTITLE: Announcements and User Interactive Voice Response IVR }} {{PAGE_HEADER}} {{Page_Menu_List_Help_AdminCenter_Feature}} ..."

New page

{{DISPLAYTITLE: Announcements and User Interactive Voice Response IVR }}
{{PAGE_HEADER}}
{{Page_Menu_List_Help_AdminCenter_Feature}}
 
<section begin=article />

{{Page_Introduction_Title}}
<section begin=intro />
Announcements and its Interactive Voice Response IVR features extends the call [[{{NAMESPACE}}:admincenter_subsc_distributions | distributions ]] with the possibility of:
:* To play a courtesy welcome text
:* To play an announcement with instructions for the caller how to proceed.
:* Provide waiting music
:* Periodically repeat an announcement text
:* Expecting interactions with the user for more specific call forwarding:
::* Start a call to any type telephone number
::* Forward to a next announcement
::* etc.

Specific actions can be taken, when a user is not providing any input, a destination is not responding or is not reachable:
:* Start a call to any type telephone number
:* Forward to a next announcement
:* Restart the announcement
:* Terminate the call
:* Wait until free
<section end=intro />

__TOC__ 

 
{{PAGE_DIVERSION_FEATURE}}
{{ToTop | }} 

 
{{PAGE_DIVERSION_CONFIGURATION}}
{{ToTop}} 
= Configuration =

{{PAGE_DIVERSION_NAVIGATION}}
{{ToTop}} 
== Where to Configure this Feature ==

As vPBX administrator:
{{Navigation_List | 1 | Tab "PBX" }}
{{Navigation_List | 2 | Tab "Subscriber xx" }}
{{Navigation_List | 3 | Tab "Voiceportal" }}

<br>
As subscriber:
{{Navigation_List | 1 | Tab "Voiceportal" }}

{{PAGE_DIVERSION_ENTITY}}
{{ToTop}} 
== Creating, Modifying and Deleting an Announcement ==

Create a new announcement:
# Enter the [[#AnnouncementName | name ]] of the new announcement in the input field
# Click {{Dialog_Button | + Add }}
# A dialog pops up, in which all configurations of the announcement are configured.
# In tab "Settings" the following parameters can be configured:
#:* Define the [[#AnnouncementName | "Name" ]] of the announcement
#:* Load, create or modify the [[#AnnoncementText | "Announcement text" ]]
#:
#:* Define automatic announcement actions:
#::* Define a [[#AnnouncementAutoActionImmediate | "Immediately" ]] action
#::* Define [[#AnnouncementAutoActionMusicWait | "Music on Wait" ]]
#::* Define a [[#AnnouncementAutoActionPeriodically | "Periodically" ]] repeated text
#::* Define the action if the [[#AnnouncementAutoActionDestNotReachable | "Destination is not reachable" ]].
#::* Define an action [[#AnnouncementAutoActionAfter | "After" ]] a timeout when no user input is received or the called destination doesn't respond in any way.
#:
# In tab "Interactions" the following parameters can be configured:
#:* Define the actions that can be executed when a user presses a [[#AnnouncementUserActionKey | "Key" ]] on its telephone keypad.
# For saving the configurations click the {{Dialog_Button | Save }}

<br>
Modify an existing announcement:
# Click the row of the desired announcement
# Modify the desired parameter
# For saving the configurations click the {{Dialog_Button | Save }}

<br>
Delete a announcement:
# Click the waste icon {{Picture_AdminCenter_Waste}} at the end of the row of the desired announcement.

{{ToTop | FeatureAnnouncementConfiguration }} 
== Configuration of an Announcement ==

An announcement is created as described in chapter [[#PageDiversionEntity | "Creating, Modifying and Deleting an Announcement" ]].

{{ToTop | FeatureAnnouncementConfigurationName }} 
=== Defining the Name ===

The announcement can be given any [[#AnnouncementName | name ]].
<br>
As announcements, will be selected by name it is recommended to give meaningful names, e.g.:
:* "Welcome to Support"
:* "Waiting Music"
:* "Sorry, try later"

{{ToTop | FeatureAnnouncementConfiguationText }} 
=== Loading the Announcement Text ===

The announcement text can be loaded in two ways:
# Load a prepared audio file
# Recording the text via your own telephone or any telephone of the vPBX

{{ToTop | FeatureAnnouncementConfigurationTextLoadFile }} 
==== Load an Announcement Text with an Audio File ====

Here an externally prepared audio file is uploaded via AdminCenter.

'''Proceeding:'''<br>
# The text must be recorded with an external device and stored in an audio file. The audio file must be created in the format WAV (PCM-encoded) or MP3!
#* Hint: <br>
#: The audio file must be stored in such a way that it can be accessed from the used web browser.
#:
#: For [[#AnnoncementText | "Announcement text"]] click on {{Dialog_Button | Play/Modify ...}}. It opens a dialog where the text can be loaded and listened to.
#:
# Click on the {{Dialog_Button | "+ Replace ..."}}, find and select the audio file in the opening file browser. After selection, the file is loaded immediately. To listen to the text, click {{Dialog_Button | > }}.
# In the dialog "Announcement", click {{Dialog_Button | Save }}

{{ToTop | FeatureAnnouncementConfigurationTextSpeech }} 
==== Loading the Announcement Text via Telephone ====

Here the announcement text is directly recorded via a telephone (similar to the [[{{NAMESPACE}}:admincenter_subsc_voicemail_box | VoiceMail Box).

'''Proceeding:'''<br>
# Prepare the recording via AdminCenter:
## Mark the selections box for "Modify using phone":
##: → A *88-code is displayed, e.g.: <tt>*881058</tt>
## Click {{Dialog_Button | Save }} in the dialog "Announcement"
#:
# Recording the text via telephone:
## In order to access the voice portal, the above generated *88-code is dialed from the own or any telephone of the vPBX, e.g.: <tt>*881058</tt>
## In the speech-guided menu, a loaded text can be listen to or replaced
#:
# Finalize the recording via AdminCenter:
## Unmark the selections box for "Modify using phone":
##: → The *88-code will disappear.
# Click {{Dialog_Button | Save }} in the dialog "Announcement"
<br>
The text can no longer be modified with the telephone via the voice portal. If the text must be modified via telephone later, the recording must be enabled again by selecting "Modify using phone".

{{ToTop | FeatureAnnouncementConfiguationImmediately }} 
=== Immediately Call Forward to the Destination ===

If after invoking the announcement, a predetermined destination has to be called immediately, the parameter [[#AnouncementAutoActionImmediate | "Immediately"]] must be set to "Start call" and the telephone number of the destination must be configured.

The text of this announcement will not be played! This can be bypassed by adding a [[#AnnouncementAutoActionPeriodically | periodically ]] played text. The text can come from any announcement, including its own.

{{ToTop | FeatureAnnouncementConfiguationMusicOnWait }} 
=== Play Music during Waiting ===

For playing music during waiting select at parameter [[#AnnouncementAutoActionMusicWait | "Music on wait"]] the setting "Play announcement" and choose the announcement whose text contains the music sample.

The music is paused when a [[#AnnouncementAutoActionPeriodically | periodically ]] text is played.

A waiting music must be loaded as an audio file in its own "announcement". The procedure is identical to the [[#FeatureAnnouncementConfigurationTextLoadFile | loading the announcement text]].

{{ToTop | FeatureAnnouncementConfiguationPeriodically }} 
=== Play Text Periodically ===

To play a text periodically, select at parameter [[#AnnouncementAutoActionPeriodically | "Periodically"]] the "Play announcement" and select the announcement with the desired text. The text will be played for the first time after the configured time has elapsed and then it is repeated periodically in the same rhythm.

{{ToTop | FeatureAnnouncementConfiguationAfter }} 
=== Automatic Action if No Response ===

If no [[#AnnouncementUserActionKey | key input]] is done by the caller or if a called destination doesn't respond then the automatic action [[#AnouncementAutoActionAfter | "After"]] can be invoked. This time-controlled action is designed to prevent the caller from having to wait unnecessarily when nothing happens.

The following actions can be selected:
:* "Restart"
:: After the defined time period, this announcement is restarted.
:
:* "Goto announcement"
:: After the defined time period, the selected announcement is called. The current announcement is stopped.
:
:* "Start call"
:: After the defined time period, the configured telephone number is called. The current announcement is stopped.
:
:* "Terminate call"
:: After the defined time period, the call and the current announcement are stopped.

{{ToTop | FeatureAnnouncementConfiguationDestNotReached }} 
=== Automatic Action, if the Destination is not Reachable ===

If the called destination cannot be reached (e.g.: user busy or call rejected), an automatic action [[#AnnouncementAutoActionDestNotReachable | "Destination not reachable"]] can be invoked. This time-controlled action is designed to prevent the caller from having to wait unnecessarily when it is known that the called destination cannot accept the call.

The following actions can be selected:
:* "Restart"
:: After the defined time period, this announcement is restarted.
:
:* "Goto announcement"
:: After the defined time period, the selected announcement is called. The current announcement is stopped.
:
:* "Terminate call"
:: After the defined time period, the call and the current announcement are stopped.
:
:* "Wait until free"
:: Until the defined time period, it will be tried to reach the destination repeatedly. After the defined time period, the current announcement is stopped.

Hint:<br>
In combination with the automatic action [[#AnnouncementAutoActionAfter | "After" ]] the caller can be forwarded to a state where he can choose a new action.

{{ToTop | FeatureAnnouncementConfiguationKey }} 
=== Actions due to Caller Inputs IVR ===

With a text the caller can be prompted to press different [[#AnnouncementUserActionKey | keys]] on the telephone keypad to start predefined actions. If the caller does not press a key, then an automatic action [[#AnouncementAutoActionAfter | "After"]] may be executed.

The following actions can be selected on the [[#AnnouncementUserActionKey | Keys 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, *, and #]]:
:* "Restart"
:: This announcement is restarted.
:
:* "Goto announcement"
:: The selected announcement is called. The current announcement is stopped.
:
:* "Start call"
:: The configured telephone number is called. The current announcement is stopped.
:
:* "Terminate call"
:: The call and the current announcement are stopped.
:
:* "Dial this digit"
:: The selected digit is stored in a buffer

{{ToTop | FeatureAnnouncementDialKey }} 
==== Special Case " Dial this digit " ====

If one or more keys are configured with "Dial this digit", the caller can use these digits to create a new telephone number and have it dialed.

The digits collected are dialed as telephone numbers when:
:* After entering of the last digit approx. 6 seconds have elapsed
:* A key is pressed with the "Start Call" action selected. For this key the telephone number must be let empty.

To prevent that any telephone number can be dialed, one ore more [[{{NAMESPACE}}: admincenter_subsc_dialing_rules | dialing rules]] must be assigned to the telephone number to which the announcement belongs.

{{PAGE_DIVERSION_PARAMETER}}
{{ToTop}} 
== Parameter Configuration ==

{{Parameter_Configuration
|link= AnnouncementName
|name= Name
|description=
Defines the name of the announcement.
|range= Any string

{{Configuration_String | Any string }}
|default= None
|version= AdminCenter V5.6
}}

{{Parameter_Configuration
|link= AnnouncementAutoActionImmediate
|name= Immediately
|description=
Defines an immediately executed action upon the invoking of the announcement. <br>
→ The text of this announcement will not be played!
<br>
With the call initiation a [[#AnnouncementAutoActionAfter | timer "After" ]] will be started. If this timer runs out its defined action will be executed.
<br>
If the destination signals that it is occupied (e.g. busy, call rejected) then [[#AnnouncementAutoActionDestNotReachable | timer "Dest. not reachable" ]] will be started. If this timer runs out its defined action will be executed.

|range=
{{Selection_Menu | Start Call
:: The configured number will be dialed immediately.
}}
|default= None
|version= AdminCenter V5.6
}}

{{Parameter_Configuration
|link= AnnouncementAutoActionMusicWait
|name= Music on Wait
|description=
Defines that the user will hear music while waiting to be connected to a destination.
|range=
{{Selection_Menu | Play announcement
:: The text of the selected "announcement" will be used as the source for music.
}}
|default= None
|version= AdminCenter V5.6
}}

{{Parameter_Configuration
|link= AnnouncementAutoActionPeriodically
|name= Periodically
|description=
Defines that the user will hear periodically an additional text.
|range=
{{Selection_Menu | Play announcement
:: The text of the selected announcement will periodically replayed. It is played the first time after the configured timeout and afterwards repeated with the same timeout.
}}
|default= None
|version= AdminCenter V5.6
}}

{{Parameter_Configuration
|link= AnnouncementAutoActionDestNotReachable
|name= Dest. not reachable
|description=
Defines the action that has to be taken when the destination is not reachable (e.g. busy, rejected the call) after the configured timeout.
<br>
This timeout shall help to prevent that the user may wait needlessly when it is known that the called cannot take the phone.
|range=
{{Selection_Menu | Restart
:: After the configured timeout this announcement is restarted.
}}
{{Selection_Menu_Item | Goto announcement
:: After the configured timeout the selected announcement is invoked. The current announcement will be terminated.
}}
{{Selection_Menu_Item | Terminate call
:: After the configured timeout the call and the current announcement will be terminated.
}}
{{Selection_Menu_Item | Wait until free
:: Until the configured timeout the destinations are polled if they are free. After this timeout, the polling is stopped.
}}
|default= None
|version= AdminCenter V5.6
}}

{{Parameter_Configuration
|link= AnnouncementAutoActionAfter
|name= After
|description=
Defines the action that has to be taken when the user does not provide an input or a placed call is not answered.
<br>
This timeout shall help to prevent that the user may wait needlessly for to be connected to any destination or to hear the announcement again, etc.
|range=
{{Selection_Menu | Restart
:: After the configured timeout this announcement is restarted.
}}
{{Selection_Menu_Item | Goto announcement
:: After the configured timeout the selected announcement is invoked. The current announcement will be terminated.
}}
{{Selection_Menu_Item | Start Call
:: After the configured timeout the configured telephone number will be dialed. The current announcement will be terminated.
}}
{{Selection_Menu_Item | Terminate call
:: After the configured timeout the call and the current announcement will be terminated.
}}
|default= None
|version= AdminCenter V5.6
}}

{{Parameter_Configuration
|link= AnnouncementUserActionKey
|name= Key
|description=
Defines the action that has to be taken when the user presses this key on the telephone keypad.
|range=
{{Selection_Menu | Restart
:: This announcement is restarted.
}}
{{Selection_Menu_Item | Goto announcement
:: The selected announcement is invoked. The current announcement will be terminated.
}}
{{Selection_Menu_Item | Start Call
:: The telephone number will be dialed. The current announcement will be terminated.
}}
{{Selection_Menu_Item | Dial this digit
:: The pressed digit will be collected in a dialing buffer.
::
:: The collected digits will be dialed as a telephone number:
::* After a timeout of ca 6 sec after the last entry of a digit
::* When a key is pressed that has the action "Start Call" (See above) with no configured number
}}
|default= None
|version= AdminCenter V5.6
}}

<section end=article />
{{ToTop}}
{{PAGE_FOOTER}}
{{Page_Version |version=3.0 |author=Aarenet |date=July 2017}}

@@ Line 322: / Line 322: @@
 '''Proceeding:'''<br>
-# The text must be recorded with an external device and stored in an audio file. The audio file must be created in the format WAV (PCM-encoded) or MP3!
+# The text must be recorded with an external device and stored in an audio file.
-#: Hint: <br>
+#: The audio file must meet the following requirements:
-#: The audio file must be stored in such a way that it can be accessed from the used web browser.
+#:* WAV- (8kHz, 16bit PCM-encoded) or MP3-formated
-#:
+#:* Max. size 1MByte (from V6.10: 2MByte)
-#: For [[#AnnoncementText | "Announcement text"]] click on {{Dialog_Button | Play/Modify ...}}. It opens a dialog where the text can be loaded and listened to.
+# For [[#AnnoncementText | "Announcement text"]] click on {{Dialog_Button | Play/Modify ...}}. It opens a dialog where the text can be loaded and listened to.
 #:
 # Click on the {{Dialog_Button | "+ Replace ..."}}, find and select the audio file in the opening file browser. After selection, the file is loaded immediately. To listen to the text, click {{Dialog_Button | &gt; }}.
@@ Line 337: / Line 337: @@
 ==== Loading the Announcement Text via Telephone ====
-Here the announcement text is directly recorded via a telephone (similar to the [[{{NAMESPACE}}:admincenter_subsc_voicemail_box | VoiceMail Box).
+Here the announcement text is directly recorded via a telephone (similar to the [[{{NAMESPACE}}:admincenter_subsc_voicemail_box | VoiceMail Box]]).
 '''Proceeding:'''<br>

@@ Line 3: / Line 3: @@
 {{Page_Menu_List_Help_AdminCenter_Feature}}
 <!-- FOOTER LEFT "© Aarenet AG 2017" --> <!-- PDF Creation Directive ------------------------------>
@@ Line 31: / Line 30: @@
 <!-- PAGE BREAK --> <!-- PDF Creation Directive --------------------------------------------------->
 {{PAGE_DIVERSION_FEATURE}}
 {{ToTop}} <!--------------------------------------------------------------------------------------->

Admincenter subsc announcement ivr - Revision history

Anadm at 14:23, 26 March 2018

Anadm at 14:32, 5 September 2017

Anadm at 14:05, 29 August 2017

Anadm: Created page with "{{DISPLAYTITLE: Announcements and User Interactive Voice Response IVR }} {{PAGE_HEADER}} {{Page_Menu_List_Help_AdminCenter_Feature}} ..."