Job Aid 73: Using VB Scripting Within Voicemail Pro

2y ago
31 Views
2 Downloads
338.92 KB
44 Pages
Last View : 22d ago
Last Download : 2m ago
Upload by : Laura Ramon
Transcription

IP OfficeUsing VB Scripting within VoicemailProSummaryVoicemail Pro Client provides a VB Scripting action that allows an administrator toconstruct callflow logic via VB-Scripting. A number of predefined methods andsystem variables are detailed within this Job Aid.A knowledge of programming and telephony systems is essential to be able to usethe VB Scripting action effectively.Job Aid 073 Issue 1 (3rd November 2003)

ContentsUSING VB SCRIPTING. 4VB SCRIPT ACTION.4PROPERTIES.5USING PROPERTIES . 6CALLINGPARTY PROPERTY .6LOCALE PROPERTY .7NAME PROPERTY .8RESULT PROPERTY.9SAVEDRESULT PROPERTY .10VARIABLE PROPERTY .10ESTIMATEDANSWER PROPERTY .11POSITIONINQUEUE PROPERTY .11NEWMSGS PROPERTY .12OLDMSGS PROPERTY .12SAVEDMSGS PROPERTY .13LASTACCESSEDMSG PROPERTY .13USING METHODS . 14REGISTER METHOD .14GETCALLINGPARTY METHOD .15GETLOCALE METHOD .15SETLOCALE METHOD .16GETNAME METHOD .16GETRESULT METHOD .17SETRESULT METHOD .17GETSAVEDRESULT METHOD .18SETSAVEDRESULT METHOD .18GETVARIABLE METHOD .19SETVARIABLE METHOD .19GETPOSITIONINQUEUE METHOD .20GETESTIMATEDANSWER METHOD .20GETNEWMSGS METHOD .21GETOLDMSGS METHOD.22GETSAVEDMSGS METHOD .22PLAYDIGITS METHOD .23PLAYLOCALEWAV METHOD .24PLAYWAV METHOD.25SPEAK METHOD .27RECORDMSG METHOD.28FULLFILENAME METHOD .29SETREGISTER METHOD .30GETREGISTER METHOD .31RECORDREGISTER METHOD .32GETDTMF METHOD .33GETEXTENSION METHOD .34GETMAILBOX METHOD .35GETMAILBOXMESSAGES METHOD .35GETMAILBOXMESSAGE METHOD .36SETMAILBOXMESSAGE METHOD .37MESSAGELENGTH METHOD .38MESSAGECLI METHOD .38MESSAGEDISPLAY METHOD .39MESSAGETIME METHOD .39GETMESSAGESTATUS METHOD .40GETMESSAGEPRIORITY METHOD .40GETMESSAGEPRIVATE METHOD .41FORWARDMSGTOMAILBOX METHOD .42FORWARDMSG METHOD .43

Page 4Using VB ScriptingVB Script ActionThis action allows an administrator to construct callflow logic via VBScripting. A number of predefined methods and system variables areavailable. Any scripting added can be verified by pressing the SyntaxCheck button.This action has two results (Success or Failure) for which connections tofollowing actions can be made. The results are based on the Scriptingentered in the Specific tab.Specific Tab: Enter VBScript: In the Script area enter the VB-Script as required.Details of the System variables and COM methods that aresupported are accessible by right clicking in the VB Script area.Page 4Job Aid 073 Issue 1 (3rd November 2003)Using VB Scripting within Voicemail ProIP Office

Page 5PropertiesVoicemail contains various state variables that are associated with aspecific interaction with voicemail. These include the caller id, name of themailbox (etc). The following system variables map to properties associatedwith the object: CLI – CallingParty Property (read-only). LOC – Locale Property (read-write). NAM – Name Property (read-only). RES – Result Property (read-write). SAV – SavedResult Property (read-write). VAR – Variable Property (read-write).Properties specific to queuing callflows (e.g. main.Queued,main.StillQueued). QPOS – PositionInQueue Property (read-only). QTIM – EstimatedAnswer Property (read-only).The following properties are related to the messages within the mailbox. NewMsgs Property – Returns the count of new messages withinthe session’s mailbox. OldMsgs Property – Returns the count of old messages within thesession’s mailbox. SavedMsgs Property – Returns the count of saved messageswithin the session’s mailbox. LastAccessedMsg Property – Returns the name of the lastrecorded or accessed message.Note: VB Scripting will only support variant types.Internal VariablesSome of the variables that exist within Voicemail Pro can be split intosmaller sections using a delimiter.Example: A CLI contains the number 01707364143. If the callflowreferences the variable as CLI@0,4 then the value 01707 will be returnedi.e. the first five numbers.Using VB Scripting within Voicemail ProIP OfficePage 5Job Aid 073 Issue 1 (3rd November 2003)

Page 6Using PropertiesCallingParty PropertyThe CallingParty property returns the caller id associated with thevoicemail session used for VBS interaction with Voicemail (equivalent to CLI system variable).SyntaxSet:(This property is read-only)Get:String Voice.CallingPartyPartsvmprov5.voicescript :The owning object.String :Set: (This property is read-only)Get: A String object containing the name of the calling party (or CLI).RemarksThe CallingParty property is only valid for the current session to Voicemail.ExampleSub Main (dlgid)dim registrationSet Voice CreateObject("vmprov5.voicescript")registration Voice.Register(dlgid)if registration Thendim calleridcallerid Voice.CallingPartyend ifEnd SubPage 6Job Aid 073 Issue 1 (3rd November 2003)Using VB Scripting within Voicemail ProIP Office

Page 7Locale PropertyThe Locale property gets and sets the LOC voicemail system variable.SyntaxSet:Voice.Locale StringGet:String Voice.LocalePartsvmprov5.voicescriptThe owning object.StringSet: A string object that contains the new value for the LOC variable.Get: A string object containing the current value for LOC.ExampleSub Main (dlgid)dim registrationSet Voice CreateObject("vmprov5.voicescript")registration Voice.Register(dlgid)if registration Thendim localeDO SOME PROCESSING.locale Voice.LocaleRem NOW SET LOCALE TO FRENCHVoice.Locale “fr”DO SOME PROCESSING.Rem NOW SET LOCALE BACK TO WHAT IT WASVoice.Locale localeend ifEnd SubUsing VB Scripting within Voicemail ProIP OfficePage 7Job Aid 073 Issue 1 (3rd November 2003)

Page 8Name PropertyThe Name property returns the name of the mailbox associated with thevoicemail session used for VBS interaction with Voicemail (equivalent to NAM system variable).SyntaxSet:(This property is read-only)Get:String Voice.NamePartsvmprov5.voicescriptThe owning object.StringSet: (This property is read-only)Get: A String object containing the name of the associated voice mailbox.Page 8Job Aid 073 Issue 1 (3rd November 2003)Using VB Scripting within Voicemail ProIP Office

Page 9Result PropertyThe Result property gets and sets the RES voicemail system variable.SyntaxSet:Voice.Result StringGet:String Voice.ResultPartsvmprov5.voicescriptThe owning object.StringSet: A string object that contains the new value for the RES variable.Get: A string object containing the current value for RES.ExampleSub Main (dlgid)dim registrationSet Voice CreateObject("vmprov5.voicescript")registration Voice.Register(dlgid)if registration Thendim resultdim successDO SOME PROCESSING.if success ThenVoice.Result TRUEelseVoice.Result FALSEend ifEnd SubUsing VB Scripting within Voicemail ProIP OfficePage 9Job Aid 073 Issue 1 (3rd November 2003)

Page 10SavedResult PropertyThe SavedResult property gets and sets the SAV voicemail systemvariable.SyntaxSet:Voice.SavedResult StringGet:String Voice.SavedResultPartsvmprov5.voicescriptThe owning object.StringSet: A string object that contains the new value for the SAV variable.Get: A string object containing the current value for SAV.Variable PropertyThe Variable property gets and sets the VAR voicemail system variable.SyntaxSet:Voice.Variable StringGet:String Voice.VariablePartsvmprov5.voicescriptThe owning object.StringSet: A string object that contains the new value for the VAR variable.Get: A string object containing the current value for VAR.Page 10Job Aid 073 Issue 1 (3rd November 2003)Using VB Scripting within Voicemail ProIP Office

Page 11EstimatedAnswer PropertyThe EstimatedAnswer property returns the QTIM voicemail systemvariable. This is the user’s estimated time to answer within the queue(secs) and is only appropriate for queuing callflows.SyntaxSet:(This property is read-only)Get:Long Voice.EstimatedAnswerPartsvmprov5.voicescriptThe owning object.StringSet: (This property is read-only).Get: A long containing the current value for QTIM.PositionInQueue PropertyThe PositionInQueue property returns the QPOS voicemail systemvariable. This is the user’s current position in the queue and is onlyappropriate for queuing callflows.SyntaxSet:(This property is read-only)Get:String Voice.PositionInQueuePartsvmprov5.voicescriptThe owning object.StringSet: (This property is read-only).Get: A string object containing the current value for QPOS.Using VB Scripting within Voicemail ProIP OfficePage 11Job Aid 073 Issue 1 (3rd November 2003)

Page 12NewMsgs PropertyThe NewMsgs property returns the number of new messages containedwithin the session mailbox.SyntaxSet:(This property is read-only)Get:Number Voice.NewMsgsPartsvmprov5.voicescriptThe owning object.StringSet: (This property is read-only).Get: The number of new messages within the mailbox.OldMsgs PropertyThe OldMsgs property returns the number of old messages containedwithin the session mailbox.SyntaxSet:(This property is read-only)Get:Number Voice.OldMsgsPartsvmprov5.voicescriptThe owning object.StringSet: (This property is read-only).Get: The number of old messages within the mailbox.Page 12Job Aid 073 Issue 1 (3rd November 2003)Using VB Scripting within Voicemail ProIP Office

Page 13SavedMsgs PropertyThe SavedMsgs property returns the number of saved messagescontained within the session mailbox.SyntaxSet:(This property is read-only)Get:Number Voice.SavedMsgsPartsvmprov5.voicescriptThe owning object.StringSet: (This property is read-only).Get: The number of saved messages within the mailbox.LastAccessedMsg PropertyThe LastAccessedMsg property returns the name of the last recordedmessage. If the IP Office TUI is used then this will also contain the name ofthe last played message.SyntaxSet:(This property is read-only)Get:String Voice.LastAccessedMsgPartsvmprov5.voicescriptThe owning object.StringSet: (This property is read-only).Get: A string object containing the fully qualified name of the last played orrecorded message.Using VB Scripting within Voicemail ProIP OfficePage 13Job Aid 073 Issue 1 (3rd November 2003)

Page 14Using MethodsThere are various methods available to interact with voicemail. Theseinclude accessing or modifying state variables which are equivalent to theabove properties but can be used to access information for specificvoicemail sessions.Ability to record, play or speak messages.Register MethodThe Register method is used to determine whether the voicemail sessionthat was used to launch the VB script is still active.Voice.Register(dlgid As Long) As BooleanParametersdlgidAn ID that is associated with the Voicemail connection. This is passed as aparameter to the VB script.Return ValueA Boolean variable indicating whether the specified voicemail session is stillactive.ExampleSub Main (dlgid)dim registrationSet Voice CreateObject("vmprov5.voicescript")registration Voice.Register(dlgid)if registration Thendo something.end ifEnd SubPage 14Job Aid 073 Issue 1 (3rd November 2003)Using VB Scripting within Voicemail ProIP Office

Page 15GetCallingParty MethodThe GetCallingParty method is used to obtain the CLI session variable.Voice.GetCallingParty([dlgid As Long 0]) As StringParametersdlgidThe connection ID as passed in to the script.Return ValueThe value of the CLI session variable associated with the specifiedvoicemail session.GetLocale MethodThe GetLocale method is used to obtain the LOC session variable.Voice.GetLocale([dlgid As Long 0]) As StringParametersdlgidThe connection ID as passed in to the script.Return ValueThe value of the LOC session variable associated with the specifiedvoicemail session.Using VB Scripting within Voicemail ProIP OfficePage 15Job Aid 073 Issue 1 (3rd November 2003)

Page 16SetLocale MethodThe SetLocale method is used to set the LOC session variable.Voice.SetLocale(locale As String,[dlgid As Long 0])ParameterslocaleThe new value for the LOC variable.dlgidThe connection ID as passed in to the script.Return ValueThis method does not return a value.GetName MethodThe GetName method is used to obtain the NAM session variable.Voice.GetName([dlgid As Long 0]) As StringParametersdlgidThe connection ID as passed in to the script.Return ValueThe value of the NAM session variable associated with the specifiedvoicemail session.Page 16Job Aid 073 Issue 1 (3rd N

Using VB Scripting within Voicemail Pro Summary Voicemail Pro Client provides a VB Scripting action that allows an administrator to construct callflow logic via VB-Scripting. A number of predefined methods and system variables are detailed within this Job Aid. A knowledge of program

Related Documents:

Foreign aid has various different forms; economic aid, social aid and "other aid" components are the main ones. Economic aid is a form of physical capital, aid to both infrastructure and the production stage, social aid refers to aid in form of human capital whereas other aid components entail food and emergency aid (Akramova 2012, 119-120).

1. What is job cost? 2. Job setup Job master Job accounts 3. Cost code structures 4. Job budgets 5. Job commitments 6. Job status inquiry Roll-up capabilities Inquiry columns Display options Job cost agenda 8.Job cost reports 9.Job maintenance Field progress entry 10.Profit recognition Journal entries 11.Job closing 12.Job .

Job Code Listing May 2022 Job Code Job Title Job Function SuccessFactors Function Job Family Salary Plan Grade FLSA Status Minimum Salary Midpoint Salary Maximum Salary. Job Code Listing May 2022 Job Code Job Title Job Function SuccessFactors Function Job Family Salary Plan Grade FLSA Status Minimum Salary Midpoint Salary

Operational Training Financial Aid Step Action 1. Click on the FINANCIAL AID option from the menu or click on the REVIEW & ACCEPT FINANCIAL AID hyperlink in the Financial Aid box. Step Action In the GIFT AID section, you will see aid that cannot be modified by a student. Gift Aid includes: Scholarships, Tuition Assistance, Grants, etc.

injury case - may apply for civil legal aid (since this leaflet deals only with civil legal aid, where we refer to "legal aid" we mean "civil legal aid"). Legal aid is financial help from public funds. It helps people who qualify to get legal advice and the help of a solicitor to put their case in court.

delete job tickets. Click the add new job ticket button to add a new job. Existing job tickets can be cloned into new jobs by using the clone job button. Click the edit button to edit the Job's key information found in the Specs window, such as the client contact, job name/title, project, job type, start date, or profit center. Click the delete

curriculum developers First Aid trainers Laypeople performing & receiving first aid What is Cochrane First Aid? Thematic Field of Cochrane Mission: Forming a global network of people advocating for the development, dissemination and uptake of high-quality evidence on first aid Promoting the use of evidence on first aid

1. Hold the hearing aid between your thumb and index finger with the battery door facing away from your ear. 2. If your hearing aid has a removal handle, insert by holding the hearing aid with the removal handle at the bottom. 3. Gently insert the canal portion of the hearing aid into your ear using your index finger to push back and tuck the hearing aid completely into place.