SmarterControl SCSIP FOR HS3

Transcription

1 DOCUMENT VERSION 1.3 FOR SCSIP AND ABOVE Creating Multi Menus, Pin number requests and call control all without any scripting knowledge. SmarterControl SCSIP FOR HS3 Manual and Examples Duncan Grant

2 1 SMARTERCONTROL SCSIP FOR HS3 CONTENTS Document Version 1.1 For SCSIP and above... 0 Support Information... 3 Adding a SIP Account Enabling and Disabling a SIP Registration account... 5 USE RECVAR... 5 Create Associated Device... 6 Deleting an Associated Device Deleting a SIP Account... 7 Update a SIP Account SCSIP A Telephone Event Occurs... 9 On Incoming Call Ringing... 9 When Outbound Call is connected... 9 When Caller ID is equal to... 9 When Call is connected... 9 When Call is disconnected... 9 When Message is recorded... 9 Max Recording Limit reached... 9 When Get Digits Timeout... 9 When Get Digits Equal to... 9 When Caller ID is not equal to... 9 When Invalid number entered When Play File Complete When Speak Complete SCSIP Control Call Play Wave file and hangup Play Wave file and record message Play Wave file and transfer call Speak and hangup Speak and record message Speak and transfer call Reject Call Make Call Execute Script... 12

3 2 Hangup Call Speak Speak and get digits Play file Selecting a TTS voice Tutorial - Simple Outbound Call No Scripting Tutorial - Simple Answering Machine / Voice Mail No Scripting Tutorial - Simple Menu No Scripting Tutorial Using Caller ID to identify a call Tutorial Using When Play File Complete No Scripting Tutorial Using When Speak Complete No Scripting Tutorial Requesting a pin number No Scripting Tutorial PLAY WAVE FILE, SPEAKING, PLAY WAVE FILE & HANGUP No Scripting Video Links to example tutorials Scripting Scripting Script format Scripting Getting the UserReigtsration Parameter Scripting Available Plugin Functions GetCallerID AnswerCall SetVoice SpeakAndGetDigits PlayAndGetDigits Say HangupCall Built In Features and above Voice Mail Administration RECORDED MESSAGES Automatically Delete Messages after ing LOGGING CALLER ID GLOBAL VARIABLES INTERUPTING A PLAY AND GET DIGITS... 40

4 3 SUPPORT INFORMATION Before requesting support please make sure you refer to the forums for answers to simple questions. In the event that you are unable to source the answer to your question you may feel free to me directly. Notes:- PLEASE READ. When following the examples included within this document or online videos please ensure you have disabled all other examples before attempting to execute a new example. Failure to do so will result in undesirable conditions. A common mistake is to forget to enable events as you build them. Homeseer can be configured by default to automatically disable new events. So before digging too deep into possible issues with your events, make sure the correct events are enabled and the events you do not want are disabled. Only a few examples have been included in this document as the possible combinations are endless. The purpose of these examples are to help guide you when building your own events and triggers.

5 4 ADDING A SIP ACCOUNT. Step 1: Enter the user name of your sip account, this will either be the username provided to you by your SIP / VOIP Provider or one you have created on your own Soft PBX system. Step 2: Enter the password for this account. Step 3: Enter the SIP host IP Address. If you have a DNS name, you can ping the DNS name to find out what the IP Address is. Step 4: OPTIONAL Change or modify the UDP / TCP Ports to match your provider if required. Step 5: OPTIONAL Set the binding IP address to the IP you wish to bind the client to, this can be useful if you have multiple IP addresses assigned and wish to use a specific address. Step 6: Click Save. After you have saved your registration details the plugin configuration page will refresh to display the newly saved details. The default value WHEN saving is enabled and an attempt to register will be automatically done. The status of the registration can be seen checked on a successful registration.

6 5 ENABLING AND DISABLING A SIP REGISTRATION ACCOUNT Use the option Enabled Checked to enable the sip registration. When unchecked the SIP Registration will be disabled and removed from the host. USE RECVAR When checked the SCSIP plugin will automatically create a global variable with the name FN-{Registration Name} Example: FN-6001 This variable will automatically be updated to contain the name of a recorded file. See Recording a Message for details.

7 6 CREATE ASSOCIATED DEVICE Associated devices enables the SCSIP plugin to update the associated device value with the current state of the plugin. This enables even more flexibility to trigger custom events. When Checked for the first time the SCSIP plugin will automatically create the virtual device and assign it to the Registration. The following status values are available. DELETING AN ASSOCIATED DEVICE. To delete an associated device, simple check the device and select delete as you would for any other HS3 device. Deleting an associated device will cause the plugin configuration page to re-enable the Create Associated Device checkbox allowing you to re-create the device should it be deleted in error.

8 7 DELETING A SIP ACCOUNT. Step 1: Select the Registration you wish to delete from the Select Registration drop down. Step 2: Click Delete

9 8 UPDATE A SIP ACCOUNT. Step 1: Select the Registration you wish to delete from the Select Registration drop down. Step 2: Make the changes necessary and click update.

10 9 SCSIP A TELEPHONE EVENT OCCURS ON INCOMING CALL RINGING This event is raised when a call is received on the specified registration. WHEN OUTBOUND CALL IS CONNECTED This event is raised when a call is made using the SCSIP plugin and the recipient answers the call. WHEN CALLER ID IS EQUAL TO This event is raised when an inbound caller ID matches the specified digits WHEN CALL IS CONNECTED This event is raised on all inbound calls that are answered WHEN CALL IS DISCONNECTED This event is raised on all calls inbound and outbound when the caller or callee is connected. WHEN MESSAGE IS RECORDED This event is raised when a recording is made. MAX RECORDING LIMIT REACHED This event is raised when a recording time limit has been reached before the caller hangs up. WHEN GET DIGITS TIMEOUT This event is raised when the timeout option for the following actions is lapsed. SpeakAndGetDigits WHEN GET DIGITS EQUAL TO This event is raised when the DTMF received matches the specified digits. WHEN CALLER ID IS NOT EQUAL TO This event is raised on an inbound call where the caller ID is NOT equal to the specified digits.

11 10 WHEN INVALID NUMBER ENTERED This even is raised when no other event to handle received digits is matched. For example. If an event exists to handle DTMF 1 and DTMF 2 then DTMF 3,4,5,6 and so on would trigger and invalid number entered event. This rule also applies where a request for multiple digit input is requested and the required length is not met. WHEN PLAY FILE COMPLETE This even is raised when the play file Action is used. This Event is useful for playing consecutive wave files and ensuring that the file has played completely before moving to the next action. WHEN SPEAK COMPLETE This even is raised when the Speak Action is used. This Event is useful for playing consecutive wave files and ensuring that the file has played completely before moving to the next action.

12 11 SCSIP CONTROL CALL PLAY WAVE FILE AND HANGUP Wave file store: C:/Program Files (x86)/homeseer HS3/PhoneWaves/ This action will Answer the call, play a wave file and hang-up the call. PLAY WAVE FILE AND RECORD MESSAGE Wave file store: C:/Program Files (x86)/homeseer HS3/PhoneWaves/ This action will Answer the call, play and wave file and record a message. Enter the timeout value for the maximum time you wish to allow callers to record a message. PLAY WAVE FILE AND TRANSFER CALL Wave file store: C:/Program Files (x86)/homeseer HS3/PhoneWaves/ This action will answer the call, play and wave file and transfer the call. Enter the number you wish to transfer the call to. SPEAK AND HANGUP This action will Answer the call, speak a message to the caller and then hang-up. Enter the text you wish to speak to the caller. Enter the voice you wish to use for the speech. Please refer to selecting a TTS voice to find out what voices you have available. SPEAK AND RECORD MESSAGE

13 12 This action will Answer the call, speak some text and record a message Enter the text you wish to speak to the caller. Enter the voice you wish to use for the speech. Please refer to selecting a TTS voice to find out what voices you have available. Enter the timeout value for the maximum time you wish to allow callers to record a message. SPEAK AND TRANSFER CALL This action will Answer the call, speak some text and transfer the call to another number. Enter the text you wish to speak to the caller. Enter the voice you wish to use for the speech. Please refer to selecting a TTS voice to find out what voices you have available. Enter the Number you wish to transfer the call to REJECT CALL This action will reject the incoming call. MAKE CALL This action will cause the SCSIP to originate an outbound call. Enter the number to make a call to. This action requires additional handling steps to control the call. See Tutorial - making a simple outbound call. EXECUTE SCRIPT

14 13 This action will cause SCSIP to execute a script against the current call. See Scripting for further details. HANGUP CALL This action will cause SCSIP Plugin to hangup / terminate the call. SPEAK Raises Trigger : On Speak Complete This action will cause SCSIP Plugin to speak text to the current call the call must already be answered to use this function. Enter the text to be spoken to the caller. Enter the voice you wish to use for the speech. Please refer to selecting a TTS voice to find out what voices you have available. SPEAK AND GET DIGITS This action will cause SCSIP to answer the call, speak to the caller and wait for digits to be entered. Enter the text to be spoken to the caller. Enter the voice you wish to use for the speech. Please refer to selecting a TTS voice to find out what voices you have available. Enter the timeout value for the maximum time you wish to allow callers to record a message. Enter the maximum length of digits to be collected. For example, if you have a menu with options 1 to 5, the length would be 1. If you have a menu of more than 10 then length would be 2 and so forth. You may also use this option to collect larger digit sequences in instances where you require a pin number or other data to be collected. PLAY FILE

15 14 Raises Trigger : On Play Wave File Complete Wave file store: C:/Program Files (x86)/homeseer HS3/PhoneWaves/ This action will cause SCSIP to play a wave file into the call the call must currently be answered. Select the wave file to be played.

16 15 SELECTING A TTS VOICE Each event within SCSIP allows users to select the voice they wish to use All available voices are listed here. If your voice is not listed then the voice TTS Engine you are trying to use is not compatible.

17 16 TUTORIAL - SIMPLE OUTBOUND CALL NO SCRIPTING. Step 1: Create an Event to initiate an outbound call. Step 2: Select the IF Clause This Event is Manually Triggered Step 3: Select the Action SCSIP Control Call {Registration} Please ensure you select the registration you wish the call to be made on. Step 4: Enter the number you wish to make a call to. Step 5: Create an event to handle the outbound call. Step 6: Select the If Clause SCSIP {Registration} / when outbound call is connected Step 7: Select the action SCSIP Control Call for {Registration} note both are the same. Step 8: Select Action Speak Text and Hang-up. Step 9: Enter the text to be spoken. Step 10: Step 5: Enter the Voice to use (See Selecting a TTS Voice)

18 17 TUTORIAL - SIMPLE ANSWERING MACHINE / VOICE MAIL NO SCRIPTING. Step 1: Create an Event to Answer the call and record a message. Step 2: Select the IF Clause SCSIP A Telephone Event Occurs / On Incoming Call Ringing. Step 3: Select Action SCSIP Control Call Step 4: Enter the text to be spoken to the caller. Step 5: Enter the Voice to use (See Selecting a TTS Voice) Step 6: Enter the Max Record Time in Seconds (Triggers - Max Recording Limit reached)

19 18 TUTORIAL - SIMPLE MENU NO SCRIPTING. When creating a menu using SCSIP, there are a minimum of 4 events / triggers required. There are as follows. Answer Call Create an event to answer the call. {6000} refers to this example registration only. Your own registration number will be different. See Adding a SIP Registration Step 1: Select the IF clause. Here we will select if Registration {6000} and select the telephone event On Incoming Call Ringing Step 2: Add Action, SCSIP Control Call / Answer Call Step 3: Add Action, SCSIP Control Call / Speak and Get Digits Step 4: Enter the text to be spoken Step 5: Enter the Voice to use (See Selected a voice for options) Step 6: Enter the menu time out in Seconds. Remember the timer begins when the speech begins so be sure to give you callers enough time to hear the entire message. Step 7: Enter the maximum digits to enter. Since we are creating a simple 2 option menu we will only require the used to enter 1 digit. Digit 1 or 2.

20 19 Handle Option{s} Create an Event to handle the options we wish to present to the user. Step 1: Set the IF clause to SCSIP a Telephone Event Occurs / When Get Digits is equal to Step 2: Enter the Digits to respond to {1} Step 3: Select Action SCSIP Control Call / Speak Text and Hang-up Step 4: Enter the text to be spoken to the caller Step 5: Enter the Voice to use (See Selected a voice for options)

21 20 Handle Timeout Create an Event to handle the Timeout Event for our menu, Step 1: Select the IF Clause SCSIP A Telephone Event Occurs / When Get Digits Timeout. Step 2: Select the Action SCSIP Control Call Speak Step 3: Enter the text to be spoken to the caller Step 4: Enter the Voice to use (See Selected a voice for options) Step 5: Add Action to Run another Event and Point it back to the start Event, in this case Answer Call.

22 21 Handle Invalid Option Create an Event to handle options that are not available in our menu. Step 1: Select the IF Clause SCSIP a Telephone Event Occurs / when invalid number entered. Step 2: Add Action SCSIP Control Call / Speak Step 3: Enter the text to be spoken to the caller Step 4: Enter the Voice to use (See Selected a voice for options) Step 5: Add Action to Run another Event and Point it back to the start Event, in this case Answer Call.

23 22 TUTORIAL USING CALLER ID TO IDENTIFY A CALL Using the caller ID to answer a call enables you to identify the caller and present callers with different menus and or trigger different events. For example, someone calling from Mobile number may want to hear an administration menu or a voice mail administration menu whereas all others who call may just be presented with a standard menu or voic system. Step1: Create an event to answer the call using When the caller id is equal to and enter the caller id. Step 2: Create an event to answer the call if the caller ID is not the admin caller Take not that the second event refers to When the caller id is NOT equal to You cannot use this combination alongside the following triggers. on incoming call ringing The on incoming call ringing is the highest priority event If this event type exists and is enabled call calls will be executed on this event.

24 23 TUTORIAL USING WHEN PLAY FILE COMPLETE NO SCRIPTING Please refer to Tutorial Using When Speak Complete replacing the Trigger event from When Speak Complete to When File Play Complete TUTORIAL USING WHEN SPEAK COMPLETE NO SCRIPTING Why use when speak complete? The SCSIP plugin is designed to run asynchronously. This mean that the plugin does not halt waiting for an action to be completed. Halting the application would cause the plugin to only be able to perform one action at a time. To remove this limitation the plugin is designed to enable users to perform multiple actions across multiple SIP registrations at any one time. A consequence of this is that you have to deal with each action by using triggers. It is important to handle the Speak Complete as we need to be aware of when the first request to speak has completed. If you simply request the action speak without handling the complete event, the next action will simple be processed which may terminate the call or override the original speak command with another. This example will NOT work as the sequence of events does not consider how long it takes the first action to speak. The correct way to handle this would be to add multiple events to be triggered when the last speaking command has been completed. To achive this we will use a counter. We use the counter to help us manage where in the call flow the caller is and what actions should be taken.

25 24 Step 1: Creat a counter to hold our value in. Step 2: Click on Counters Tab Step 3: Click Create Counter Step 4: Enter the name for this counter. For this example we will enter scsip_a Step 5: Click Save We can now see our newly created counter.

26 25 Step 6: Create an Event called SCSIP ANSWER THE CALL using the values bellow. Note that SCSIP {Registration} will be different on your own computer, Simply ensure that whatever registration you select in the IF Clause is the same registration you use for the Actions. Take special not that we reset the counter scsip_a here to ensure that the counter has a value of Zero {0}. Step 7: Create an event using the details bellow to speak some text when the call is connected. Note that SCSIP {Registration} will be different on your own computer, Simply ensure that whatever registration you select in the IF Clause is the same registration you use for the Actions. Take special not that we set the counter scsip_a here to ensure that the counter has a value of One {1}, which we will later use to identify this spoken text event has finished.

27 26 Step 8: Create an Event using the details bellow to handle the When Speak Complete AND the scsip_a counter has a value of 1. Note that SCSIP {Registration} will be different on your own computer, Simply ensure that whatever registration you select in the IF Clause is the same registration you use for the Actions. We also set the scsip_a counter to 2 before speaking in the actions, this is in preperation for the next speak event. Step 9: Create an Event using the details bellow to handle the last speaking command and hangup the call. Take note again that we have checking for the scsip_a counter with a value of 2 All Done, Ensuring that each of the newly created events are enabled, we are ready to dial our registration and try out it out.

28 27 TUTORIAL REQUESTING A PIN NUMBER NO SCRIPTING Let s take a look at how we would request a 4 digit pin number from a user before giving them access to our Administration menus. Please note that should you have multiple menus on the same line you may wish to employ the use of counters to ensure that you are triggering events based on the correct actions. Please see Tutorial Using When Speak Complete for more information. We will also use a second counter here to terminate the call on 3 failed tries. SCSIP_1_Fails. This variable will be decrement each time the caller enters an invalid number allowing us to respond differently when the SCSIP_1_Fails count is equal to 0. Why does the SCSIP_1_Fails decrement rather than count upward. Simple, HS3 has no way of checking if a value is less than only equal to or greater than so we have to work in reverse. Here is what the end result will look like. Step 1: Create an event to answer the call using the following as an example.

29 28 Step 2: Create an event to handle the call connected, here we will be playing some text and requesting digits.

30 29 Step 3: Create an event to handle the invalid number entered. Take note that here we are also checking for the counter scsip_a to have a value of 1 and we are decrementing the SCSIP_1_Fails counter. We also check the ensure that the scsip_1_fails counter exceeds the value of zero {0} Step 4: Create an event to handle an invalid number entered and the amount of re-tries has reached three. Note that this time we change the AND IF clause to check if the SCSIP_1_FAILS has an absolute value of zero {0} then we change the action to speak text and hangup, thus terminating the call or the third incorrect try.

31 30 Step 5: Create an Event to handle the correct pin number entry. Using the details below we create an event to respond when the digits 1234 have been entered. For this example we will simply play a message this is part 2 and hangup the all. However obviously the use of PIN number entry would suggest an administration menu. Here one might chose to execute another event which contains an administration menu or other actions that require authorisation. Step 6: Creating events to handle the no data entry timeout. Here we have two events, the first event catches the event When get digits timeout and the scsip_1_fails is greater than zero. Then from here we execute the event Invalid Pin Number which will derement the scsip_1_fails counter for us and re-execute the menu.

32 31 Step 7: Creating an event to handle no data entry timeout and all retries have been depleated. Note that for this last event we push the call to re-run the INVALID PIN NUMBER FAILED event, this is because that event already plays a failed message and terminates the call so there is no need to creat another. TUTORIAL PLAY WAVE FILE, SPEAKING, PLAY WAVE FILE & HANGUP NO SCRIPTING This is an example of Playing a wave file, waiting for the wave file to complete before speaking. Waiting for the speaking to finish before playing another wave file and then hanging up the call. To achive this we need 4 events as follows. Step 1: Create an event to Answer the call as follows.

33 32 Step 2: Create an event to play a wave file on call connected as follows. Step 3: Create an event to Speak some text when the wave file has finished playing as follows. Step 4: Create an event to play another wave file when the speaking has finished and hang-up the call as follows.

34 33 VIDEO LINKS TO EXAMPLE TUTORIALS Example on how to configured HS3 events to play and audio file, speak some text and then play another audio file and hangup the call using SCSIP. Requesting a Pin Number PLEASE BE AWARE THAT ONLINE VIDEOS MAY BECOME OUTDATED AS NEW VERSIONS OF THE PRODUCT ARE RELEASED.

35 34 SCRIPTING Sub Main(parm As Object) Try 'Start the script hs.writelog("debug", "SmarterControl Script for SIP controller") 'Parameter Passed In contains the UserRegistration from which the script is being called. 'This parameter will need to be stored as we must pass this parameter back for each Function Call. Dim UserRegistration As String = CStr(parm) hs.writelog("debug", "Registration User is :" & UserRegistration) ' get a reference to the plugin Dim SCSIP = New HomeSeerAPI.PluginAccess(hs, "SCSIP", "") hs.writelog("debug", "SCSIP Handle Received") ''Request the caller id information Dim CallerID As String = SCSIP.PluginFunction("GetCallerID", {UserRegistration}) hs.writelog("debug", "SCSIP Call From :" & CallerID) 'Setting the voice to use for this line. '1. Bring up a run dialog by pressing Windows key + R. '2. Type in the following command into the run dialog box and press enter when done. 'C:\Windows\SysWOW64\Speech\SpeechUX\sapi.cpl '3. Select the voice you wish to use, copy the name and enter it in the SetVoice Property 'Example: Vocalizer Expressive Serena Premium High 22kHz 'Note that if you do not enter the name exactly as it appear this property will be ignored. 'Parameters {Name of voice,user} SCSIP.PluginFunction("SetVoice", {"Vocalizer Expressive Serena Premium High 22kHz", UserRegistration}) ' call the function and get the value 'Parameters {User} SCSIP.PluginFunction("AnswerCall", {UserRegistration}) hs.writelog("debug", "SCSIP Call Answered") 'Speak Text and Get Digits Dim GetDigits As String 'Parameters {TextToSpeak,TerminationKey,Max Digits To Collect, User, Timeout} GetDigits = SCSIP.PluginFunction("SpeakAndGetDigits", {"Please Enter a three digit number", "#", 3, UserRegistration, 10}) hs.writelog("debug", "SCSIP RESPONSE FROM SPEAK :" & GetDigits) 'Play Back A response to the user. SCSIP.PluginFunction("Say", {"This is an example script. You Entered " & GetDigits, UserRegistration}) SCSIP.PluginFunction("Say", {"Now we are going to play a pre recorded wave file and request digits", UserRegistration})

36 35 SCRIPTING SCRIPT FORMAT. The first thing to take care of when dealing with scripts is the sub Main. This is case sensitive and must contain a parameter of parm As Object Sub Main(parm As Object) End sub When SCSIP executes a script, the first thing it will do is pass the USER name of the registration that the call has been received on. This allows the script to ensure that any callback functions made to the plugin are executed on the correct call. SCRIPTING GETTING THE USERREIGTSRATION PARAMETER. Sub Main(parm As Object) Dim UserRegistration as String = CStr(parm) End sub This parameter is important and required on all functions calls back to the plugin. SCRIPTING AVAILABLE PLUGIN FUNCTIONS. GETCALLERID Example of use: Dim CallerID As String = SCSIP.PluginFunction("GetCallerID", {UserRegistration}) Parameters : UserRegitsration ANSWERCALL Example of use: SCSIP.PluginFunction("AnswerCall", {UserRegistration}) Parameters : UserRegitsration SETVOICE Example of use:

37 36 SCSIP.PluginFunction("SetVoice", {"Vocalizer Expressive Serena Premium High 22kHz", UserRegistration}) Parameters : UserRegitsration SPEAKANDGETDIGITS Example of use: Dim GetDigits = SCSIP.PluginFunction("SpeakAndGetDigits", {"Please Enter a three digit number", "#", 3, UserRegistration, 10}) Parameters : Text to speak, termination key, max length, UserRegitsration, timeout Termination key : a key to be assigned should you wish to terminate the imput early. Example would be (#) with a length of 5, should the caller only enter 2 digits followed by the (#)key this would terminate the input and continue the script. PLAYANDGETDIGITS Example of use: GetDigits = SCSIP.PluginFunction("PlayAndGetDigits", {"E:\test.wav", "#", 4, UserRegistration, 10}) Parameters : Path To File, termination key, max length, UserRegitsration, timeout SAY Example of use: 'Play Back A response to the user. SCSIP.PluginFunction("Say", {"After Playing a wave file You Entered " & GetDigits, UserRegistration}) Parameters : UserRegitsration HANGUPCALL Example of use: SCSIP.PluginFunction("HangupCall", {UserRegistration})

38 37 BUILT IN FEATURES AND ABOVE VOICE MAIL ADMINISTRATION This feature automatically catalogues the recordings that have been made using the recording feature of the plug-in and offers a simple way to access voice mail / recordings remotely. Access Code: This is the code used to protect the administration menu. Allow from CID only: This prevents the feature from being executed on every caller. Setting your caller ID here will ensure that the feature is only available on that caller ID. Allow Deleting: This features enables users of the VM administration to delete messages via the telephone admin menu Option (2) Speak Time and Date: This feature causes the VM administration to speak the call time and date prior to playing the recording. Speak Caller Number: This feature causes the VM administration to speak the telephone number of the caller who left the message. Play Instructions: This feature causes the VM administration to speak the instructions each time the VM Administration feature is accessed. Turning this off enables quicker usability once the instructions are understood. Play message Number: This feature causes the VM administration menu to speak the number of the message playing.

39 38 When no messages are available you will automatically be connected to the voice mail admin menu which. If messages are available, the system will proceed to play the messages back, at any time you can press (0) during the play back of a message to quit the playback and enter the Administration Menu Playback Message Menu: 0) Administration Menu 0) Exit 1) Change Pin 2) Toggle delete 3) Toggle Time and Date 4) Toggle Caller Number 5) Toggle Instructions 6) Toggle Message number 2) Move to next message (1) 3) Delete Message (2) RECORDED MESSAGES When this feature is enabled, after a message has been recorded the system will automatically you a copy of the voice file recorded. Please ensure that you have configured HS3 to send s correctly before using this feature. If HS3 configuration has not been setup you will not receive an s. Sample message AUTOMATICALLY DELETE MESSAGES AFTER ING When this feature is enabled the recorded message will be ed to the recipient and then the original recorded deleted from the file system.

40 39 LOGGING SCSIP has some advanced logging features. These can be configured as follows. Please note that the plugin will have to be re-started after the SIP Logging level has been changed.

41 40 CALLER ID GLOBAL VARIABLES SCSIP is able to automatically update a global variable with the caller id of the incoming call. To use this feature simply create a variable with the name CID- REGISTRATION NAME The registration name is the username you entered for the line. Remember to set the variable type to String. Now when a call is received on that line, the variable will automatically be updated with the Caller ID. INTERUPTING A PLAY AND GET DIGITS During the process of a play and get digits, SCSIP will automatically terminate this request if another speak or play file is received. This allows users to interrupt menus allow SCSIP to be more reactive to events and triggers. SETTING TTS VOICE RATE The Global settings for voice configuration will take effect on all events that use speak for that voice. The range is from -10 to 10 where (0) zero is the default speed.