Appendix A: Interfacing With Other Programs; Command File Interface; Request Port" Command - Toshiba STRATA CIX System Administrator Manual

Appendix A: Interfacing with Other
Programs

Command File Interface

A command file interface is supported to allow other applications to request Voice Assistant to run
IVR scripts. Voice Assistant monitors its "\REQ" subdirectory for command request files to appear
with the filename <fname>.REQ or an <fname>.RER. It will then open the file and read one line for
a command (in the format below) and attempt to execute the command and delete the command
file. If the request file ends with ".RER" it indicates the requesting application desires a 'Return
Response', so Voice Assistant will return communication via a response file with the same
<filename> but with a ".RTN" file suffix.

"Request Port" Command:

This must be the first command for a 'call'. This command requests a port and gives a starting
script for the call. If the request is granted, the voice port will immediately begin running the IVR
script, so if it is to answer a call, the requesting application must transfer the call immediately to the
voice port extension returned.
REQ:<port>,<Call_ID>,<RtnInfo>,<Script/Funct.>,<Script #>,<Parm1>,... <Param'n'>
Where;
<port> - specific Port Number, or "*" = any port (in Group #1), or "G1" for Group #1, "G8" for Group
#8, etc.
<Call_ID> - String identifying call -- used to identify the call in return communication – this can be
left blank.
<RtnInfo> - Return Info -- 'W'-waits allowed, +Ext to Return calls to,
<Script/Function> - "S"cript or "F"unction
<Script #> - Number identifying function to be performed
<Param'n'> - comma-delimited parameters to be passed to the Script
Example: Request any Voice Assistant port to run script #599 with parameter 1007
REQ: *, 1, W, S, 599, 1007
RESPONSES:
GRANT:<Call_ID>,<Ext>,<Rtn>
Where;
<Ext> - extension of the port to perform the function, you must transfer call to this port within 'x'
seconds or a Timeout error will occur.
<Rtn> - Expect this call to return after VA processing ("Y"es/"N"o/"W"ait)
Voice Assistant Adminstrator Guide 10/08
27