Howto:Record an announcement by phone: Difference between revisions

From innovaphone wiki
Jump to navigation Jump to search
 
(93 intermediate revisions by 8 users not shown)
Line 4: Line 4:


* All PBX's running Version 6 and higher
* All PBX's running Version 6 and higher
* For V13 there is a dedicated article [[Howto:V13_Record_an_announcement_by_phone]]


<!-- Keywords: Voicemail Record Script -->
<!-- Keywords: Voicemail Record Script -->


==More Information==
==More Information==
Sometimes customers wants to record a dynamic announcement (eg for a holiday) using a phone.
Sometimes customers want to record a dynamic announcement (eg for a holiday) using a phone.
This can be done by a Voicemailscript based on the innovaphone Voicemail. Voicemail licenses are mandatory since the script uses audio files of the innovaphone voicemail package. If you change the script file to use own recorded messages, no voicemail licenses are needed.
This can be done by a Voicemailscript based on the innovaphone Voicemail. Voicemail licenses are mandatory since the script uses audio files of the innovaphone voicemail package. If you change the script file to use own recorded messages, no voicemail licenses are needed.


===Configuration===
==Configuration==


====Obtain the necessary files====
=== Download the necessary files===


For a Dutch version of this tool, download [[Media:RecordAnnouncement.zip]], for a German version download [[Media:de-RecordAnnouncement.zip]], for Norwegian version download [[Media:NO-RecordAnnouncement.zip]]. Unzip these files and copy them to the Compact Flash-card of the innovaphone PBX.
There is a Dutch, German, French and Norwegian version in the [[Howto:Record an announcement by phone#Download | Download ]] section available.
For the configuation below we assume that these files are copied to the RecordAnnouncement-directory of the root-directory of the Compact Flash-card (http://127.0.0.1/DRIVE/CF0/RecordAnnouncement).


After copying these files to the Compact Flash-card the following files are found under /DRIVE/CF0/RecordAnnouncement:
=== Copy the files===
From V13 on you can upload files to the AP-Platform via the Files-app. On previous versions a WebDAV-server (like the built-in 'Compact Flash'- or Flash-drive) is needed.


[[Image:RecordAnnouncement_Files_1.gif]]
==== Using V13 Files-app as storage location====
'''Step 1''': Open the Files-App, create a logical directory and drag and drop the downloaded files in this directory:


====Create Voicemail-object to reach this script====
[[Image:001_-_Copy-Files.png]]


By configuring a Voicemail-object we will be able to reach this RecordAnnouncement-script and this way record an Announcement.
[Please note: some languages only have .g711a files]
 
'''Step 2''': Share the directory with a username and password, but do not enter a username nor a password '''(this is a small hack)''':
 
[[Image:002_-_Share-with-pwd.png]]
 
 
'''Step 3''': Get the URL to the directory (copy it, as it will be needed further on):
 
[[Image:003_-_Get-Link.png]]
 
 
'''Step 4''': Adjust the URL <nowiki>https://</nowiki>apps.voipserver.online/voipserver.online/files/UI/Scripts/Record/<file>'''&fileskey=lvlXiv_l!lyLpZyV'''
 
* Remove the filekey:
<nowiki>https://</nowiki>apps.voipserver.online/voipserver.online/files/'''UI'''/Scripts/Record/<file>
 
* Replace '''UI''' by '''root''':
<nowiki>https://</nowiki>apps.voipserver.online/voipserver.online/files/'''root'''/Scripts/Record/<'''file>'''
 
* Replace '''<file>''' by '''Record.xml''':
<nowiki>https://</nowiki>apps.voipserver.online/voipserver.online/files/root/Scripts/Record/'''Record.xml'''
 
==== Using WebDav as storage location====
'''Step 1''': Open a WebDAV-client (like WinSCP); connect to the CF-or Flash-drive of the PBX and create a logical directory. Copy all downloaded files into this directory.
 
[[Image:101_-_Copy-Files.png]]
 
[Please note: some languages only have .g711a files]
 
 
'''Step 2''': Get the URL to the 'Record.xml'-file (copy it, as it will be needed further on):
 
[[Image:102_-_Get-Link.png]]
 
=== Create Voicemail-object to reach this script===
 
By configuring a Voicemail-object we will be able to reach this Record-script and this way record an Announcement.
Go to '''Administration -> PBX -> Objects''' and select ''''Voicemail'''' in the listbox. Click on ''''new'''' to make an new Voicemail-object.
Go to '''Administration -> PBX -> Objects''' and select ''''Voicemail'''' in the listbox. Click on ''''new'''' to make an new Voicemail-object.


'''Long Name''': Record Holiday Announcement
* '''General -> Long Name''': 'Record Holiday'


'''Display Name''': Record Holiday Announcement
* '''General -> Name''': 'record_holiday'


'''Name''': Record Holiday Announcement
* '''General -> Number''': ##1


'''Number''': ##1
* '''Voicemail -> Script URL''': paste the retrieved URL and append (optionally) with the desired filename (?$_fileName=Holiday):


'''Voicemail -> Script URL''': http://127.0.0.1/DRIVE/CF0/RecordAnnouncement/Record.xml?$_coder=g711a&$_fileName=Holiday
:* URL from the Files-app:
:<nowiki>https://</nowiki>apps.voipserver.online/voipserver.online/files/root/Scripts/Record/Record.xml?$_fileName=Holiday  


[[Image:RecordAnnouncement_VM_Object.gif]]
:* URL from the CF- or Flash-drive:
:<nowiki>http://</nowiki>127.0.0.1/DRIVE/CF0/Scripts/Record/Record.xml?$_fileName=Holiday




[[Image:201_Object.png]]
[[Image:202_Object.png]]




The URL of the script can have some options:
The URL of the script can have some options:
<!-- ; $_coder : specifies the coder of the recorded message (if omitted or other than 'g729' and 'g711a': g711a will be assumed) -->
* $_fileName : specifies the name of the file of the recorded message (if omitted this will be 'RecordedMessage'). By creating multiple Voicemail-objects pointing to the same script, but with a different fileName you can record multiple dynamic announcements.


'''$_coder''': specifies the coder of the recorded message (if omitted or other than 'g729' and 'g711a': g711a will be assumed)
=== Record an announcement===
When you now call to the object, you will be able to record an announcement, just as you would do to record a personal greeting of your innovaphone voicemail (speechfiles and logic are taken from the innovaphone Voicemail-script).


'''$_fileName''': specifies the name of the file of the recorded message (if omitted this will be 'RecordedMessage').
The file will be saved in the same directory as this recordAnnouncement-script.  
By creating multiple Voicemail-objects pointing to the same script, but with a different fileName you can record multiple dynamic announcements.
Each time you call this Voicemail-object you will be able to listen to the recorded announcement, delete this announcement or record a new announcement.


=== Using the recorded file===


When you now call to the object, you will be able to record an announcement, just as you would do to record a personal greeting of your innovaphone voicemail (speechfiles and logic are taken from the innovaphone Voicemail-script).
After recording a file, this file can be used to be played by a Waiting Queue-object.
 
====Via the Advanced UI====
Just create an new Waiting Queue-object under '''Adminstration -> PBX -> Objects''' and point to the file:


* '''General -> Long Name''': Play Holiday


The file will be saved in the same directory as this recordAnnouncement-script:
* '''General -> Name''': play_holiday


[[Image:RecordAnnouncement_Files_2.gif]]
* '''General -> Number''': ##2


Each time you call this Voicemail-object you will be able to listen to the recorded announcement, delete this announcement or record a new announcement.
* '''Queue -> 1st Announcement -> URL''': <nowiki>http://</nowiki>127.0.0.1/DRIVE/CF0/Scripts/Record/Holiday.$coder?coder=g711a&repeat=true


====Using the recorded file====
* '''Queue -> Alert TimeOut''': 0


After recording a file, this file can be used to be played by an Waiting Queue-object.  
The last two options will play the file 'Holiday.g711a' located in the /Scripts/Record/-maf of the Compact Flash-card directly (TimeOut: 0) and constantly (repeat=true).
Just create an new Waiting Queue-object under '''Adminstration -> PBX -> Objects''' and point to the file:


'''Long Name''': Play Holiday Announcement
[[Image:301_Object.png]]


'''Display Name''': Play Holiday Announcement
[[Image:302_Object.png]]


'''Name''': Play Holiday Announcement
====Via the 'PBX-Manager -> Waiting Queues'-app====
* Open the 'PBX Manager'-app followed by the 'Waiting Queues'-app.
[[Image:401_Add_Queue.png]]


'''Number''': 60
* Click on '+ Add a waiting queue'-button and enter the needed information for the Waiting Queue:
:'''* Waiting queue:''' 'Play Holiday'
:'''* SIP''': 'play_holiday'
:'''* Number:''' ##2
[[Image:402_Add_Queue.png]]


'''Queue -> 1st Announcement -> URL''': http://127.0.0.1/DRIVE/CF0/RecordAnnouncement/Holiday.$coder?coder=g711a&repeat=true
* Click on the 'OK'-button; re-open the Waiting Queue and select the correct annnouncement (here Holiday):
[[Image:403_Add_Queue.png]]


'''Queue -> Alert TimeOut''': 0
[[Image:404_Add_Queue.png]]


The last two options will play the file 'Holiday.g711a' located in the RecordAnnouncemnt-directory of the Compact Flash-card directly (TimeOut: 0) and constantly (repeat=true).
* Adjust the URL if needed (here: play in a loop):
[[Image:405_Add_Queue.png]]


[[Image:RecordAnnouncement_WQ.gif]]
* Adjust the Time to Announcement(s), so that the message is played (here immediately):
[[Image:406_Add_Queue.png]]


===Limitations===
===Limitations===
Line 86: Line 146:
Recorded files are stored in the same directory as the script.
Recorded files are stored in the same directory as the script.


This script now uses only the Dutch, German or Norwegian speech files of the innovaphone Voicemail. It should be easy to change this to use the other languages provided by the innovaphone Voicemail.
This script now uses only the Dutch, French, German and Norwegian speech files of the innovaphone Voicemail. It should be easy to change this to use the other languages provided by the innovaphone Voicemail.


==Download==
==Download==
[http://download.innovaphone.com/ice/wiki-src#phonerec http://download.innovaphone.com/ice/wiki-src#phonerec] - download the complete file package of scripts and files described in this article
[http://wiki.innovaphone.com/index.php?title=Howto:Wiki_Sources#phonerec Download] the complete file package of scripts and files described in this article


== Related Articles ==
== Related Articles ==
[[Howto:V13_Record_an_announcement_by_phone]]
[[Howto:Simple_Message_Management|Howto:Simple Message Management]]


[[Howto:How_to_Configure_the_innovaphone_Voicemail|How to Configure the innovaphone Voicemail]]
[[Howto:How_to_Configure_the_innovaphone_Voicemail|How to Configure the innovaphone Voicemail]]
Line 99: Line 162:
[[Howto:How to convert wave files in to G7xx coder files for the HTTP interface]]
[[Howto:How to convert wave files in to G7xx coder files for the HTTP interface]]


[[Howto:Installing_the_voicemail/music_on_hold_on_a_compact_flash_card]]
[[Howto:Installing_the_voicemail/music_on_hold_on_a_compact_flash_card|Installing the voicemail/music on hold on a compact flash card]]


[[Howto:General_information_for_compact_flash_cards]]
[[Howto:General_information_for_compact_flash_cards|General information for compact flash cards]]


[[Category:Sample|{{PAGENAME}}]]
[[Category:Sample|{{PAGENAME}}]]

Latest revision as of 08:28, 21 April 2022

3rd party input
this is 3rd party content not provided by innovaphone, see history for authors.

Applies To

This information applies to


More Information

Sometimes customers want to record a dynamic announcement (eg for a holiday) using a phone. This can be done by a Voicemailscript based on the innovaphone Voicemail. Voicemail licenses are mandatory since the script uses audio files of the innovaphone voicemail package. If you change the script file to use own recorded messages, no voicemail licenses are needed.

Configuration

Download the necessary files

There is a Dutch, German, French and Norwegian version in the Download section available.

Copy the files

From V13 on you can upload files to the AP-Platform via the Files-app. On previous versions a WebDAV-server (like the built-in 'Compact Flash'- or Flash-drive) is needed.

Using V13 Files-app as storage location

Step 1: Open the Files-App, create a logical directory and drag and drop the downloaded files in this directory:

001 - Copy-Files.png

[Please note: some languages only have .g711a files]

Step 2: Share the directory with a username and password, but do not enter a username nor a password (this is a small hack):

002 - Share-with-pwd.png


Step 3: Get the URL to the directory (copy it, as it will be needed further on):

003 - Get-Link.png


Step 4: Adjust the URL https://apps.voipserver.online/voipserver.online/files/UI/Scripts/Record/<file>&fileskey=lvlXiv_l!lyLpZyV

  • Remove the filekey:

https://apps.voipserver.online/voipserver.online/files/UI/Scripts/Record/<file>

  • Replace UI by root:

https://apps.voipserver.online/voipserver.online/files/root/Scripts/Record/<file>

  • Replace <file> by Record.xml:

https://apps.voipserver.online/voipserver.online/files/root/Scripts/Record/Record.xml

Using WebDav as storage location

Step 1: Open a WebDAV-client (like WinSCP); connect to the CF-or Flash-drive of the PBX and create a logical directory. Copy all downloaded files into this directory.

101 - Copy-Files.png

[Please note: some languages only have .g711a files]


Step 2: Get the URL to the 'Record.xml'-file (copy it, as it will be needed further on):

102 - Get-Link.png

Create Voicemail-object to reach this script

By configuring a Voicemail-object we will be able to reach this Record-script and this way record an Announcement. Go to Administration -> PBX -> Objects and select 'Voicemail' in the listbox. Click on 'new' to make an new Voicemail-object.

  • General -> Long Name: 'Record Holiday'
  • General -> Name: 'record_holiday'
  • General -> Number: ##1
  • Voicemail -> Script URL: paste the retrieved URL and append (optionally) with the desired filename (?$_fileName=Holiday):
  • URL from the Files-app:
https://apps.voipserver.online/voipserver.online/files/root/Scripts/Record/Record.xml?$_fileName=Holiday
  • URL from the CF- or Flash-drive:
http://127.0.0.1/DRIVE/CF0/Scripts/Record/Record.xml?$_fileName=Holiday


201 Object.png

202 Object.png


The URL of the script can have some options:

  • $_fileName : specifies the name of the file of the recorded message (if omitted this will be 'RecordedMessage'). By creating multiple Voicemail-objects pointing to the same script, but with a different fileName you can record multiple dynamic announcements.

Record an announcement

When you now call to the object, you will be able to record an announcement, just as you would do to record a personal greeting of your innovaphone voicemail (speechfiles and logic are taken from the innovaphone Voicemail-script).

The file will be saved in the same directory as this recordAnnouncement-script. Each time you call this Voicemail-object you will be able to listen to the recorded announcement, delete this announcement or record a new announcement.

Using the recorded file

After recording a file, this file can be used to be played by a Waiting Queue-object.

Via the Advanced UI

Just create an new Waiting Queue-object under Adminstration -> PBX -> Objects and point to the file:

  • General -> Long Name: Play Holiday
  • General -> Name: play_holiday
  • General -> Number: ##2
  • Queue -> 1st Announcement -> URL: http://127.0.0.1/DRIVE/CF0/Scripts/Record/Holiday.$coder?coder=g711a&repeat=true
  • Queue -> Alert TimeOut: 0

The last two options will play the file 'Holiday.g711a' located in the /Scripts/Record/-maf of the Compact Flash-card directly (TimeOut: 0) and constantly (repeat=true).

301 Object.png

302 Object.png

Via the 'PBX-Manager -> Waiting Queues'-app

  • Open the 'PBX Manager'-app followed by the 'Waiting Queues'-app.

401 Add Queue.png

  • Click on '+ Add a waiting queue'-button and enter the needed information for the Waiting Queue:
* Waiting queue: 'Play Holiday'
* SIP: 'play_holiday'
* Number: ##2

402 Add Queue.png

  • Click on the 'OK'-button; re-open the Waiting Queue and select the correct annnouncement (here Holiday):

403 Add Queue.png

404 Add Queue.png

  • Adjust the URL if needed (here: play in a loop):

405 Add Queue.png

  • Adjust the Time to Announcement(s), so that the message is played (here immediately):

406 Add Queue.png

Limitations

The recorded announcement can only be in one codec (g711a or g729).

Recorded files are stored in the same directory as the script.

This script now uses only the Dutch, French, German and Norwegian speech files of the innovaphone Voicemail. It should be easy to change this to use the other languages provided by the innovaphone Voicemail.

Download

Download the complete file package of scripts and files described in this article

Related Articles

Howto:V13_Record_an_announcement_by_phone

Howto:Simple Message Management

How to Configure the innovaphone Voicemail

Howto:Convert wave files to G7xxx with softcode

Howto:How to convert wave files in to G7xx coder files for the HTTP interface

Installing the voicemail/music on hold on a compact flash card

General information for compact flash cards

Retrieved from "https://wiki.innovaphone.com/index.php?title=Howto:Record_an_announcement_by_phone&oldid=61740"