Fix/Implement error events for non-existing files
[asterisk/asterisk.git] / doc / externalivr.txt
1 Asterisk External IVR Interface
2 -------------------------------
3
4 If you load app_externalivr.so in your Asterisk instance, you will
5 have an ExternalIVR() application available in your dialplan. This
6 application implements a simple protocol for bidirectional
7 communication with an external process, while simultaneous playing
8 audio files to the connected channel (without interruption or
9 blocking).
10
11 The arguments to ExternalIVR() consist of the command to execute and
12 any arguments to pass to it, the same as the System() application
13 accepts. The external command can be executed in a child process,
14 with its standard file handles connected to the Asterisk process as
15 follows:
16
17 stdin (0) - DTMF and hangup events will be received on this handle
18 stdout (1) - Playback and hangup commands can be sent on this handle
19 stderr (2) - Error messages can be sent on this handle
20
21 The application will also create an audio generator to play audio to
22 the channel, and will start playing silence. When your application
23 wants to send audio to the channel, it can send a command (see below)
24 to add a file to the generator's playlist. The generator will then
25 work its way through the list, playing each file in turn until it
26 either runs out of files to play, the channel is hung up, or a command
27 is received to clear the list and start with a new file. At any time,
28 more files can be added to the list and the generator will play them
29 in sequence.
30
31 While the generator is playing audio (or silence), any DTMF events
32 received on the channel will be sent to the child process (see
33 below). Note that this can happen at any time, since the generator,
34 the child process and the channel thread are all executing
35 independently. It is very important that your external application be
36 ready to receive events from Asterisk at all times (without blocking),
37 or you could cause the channel to become non-responsive.
38
39 If the child process dies, ExternalIVR() will notice this and hang up
40 the channel immediately (and also send a message to the log).
41
42 ExternalIVR() Options
43 ----------------------
44 n: 'n'oanswer, don't answer an otherwise unanswered channel.
45 i: 'i'gnore_hangup, instead of sending an 'H' event and exiting
46 ExternalIVR() upon channel hangup, it instead sends an 'I' event
47 and expects the external application to exit the process.
48 d: 'd'ead, allows the operation of ExternalIVR() on channels that
49 have already been hung up.
50
51 DTMF (and other) events
52 -----------------------
53
54 All events will be newline-terminated strings.
55
56 Events sent to the child's stdin will be in the following format:
57
58 tag,timestamp[,data]
59
60 The tag can be one of the following characters:
61
62 0-9: DTMF event for keys 0 through 9
63 A-D: DTMF event for keys A through D
64 *: DTMF event for key *
65 #: DTMF event for key #
66 H: the channel was hung up by the connected party
67 E: the script requested an exit
68 Z: the previous command was unable to be executed
69 T: the play list was interrupted (see S command below)
70 D: a file was dropped from the play list due to interruption (the
71 data element will be the dropped file name) NOTE: this tag conflicts
72 with the D DTMF event tag. The existence of the data element is used
73 to differentiate between the two cases
74 F: a file has finished playing (the data element will be the file
75 name)
76 P: a response to the 'P' command (see below)
77 G: a response to the 'G' command (see below)
78 I: a Inform message, meant to "inform" the client that something
79 has occured.  (see Inform Messages below)
80
81 The timestamp will be 10 digits long, and will be a decimal
82 representation of a standard Unix epoch-based timestamp.
83
84 Commands
85 --------
86
87 All commands must be newline-terminated strings.
88
89 The child process can send commands on stdout in the following formats:
90
91 S,filename
92 A,filename
93 H,message
94 E,message
95 O,option
96 V,name=value[,name=value[,name=value]]
97 G,name[,name[,name]]
98 L,log_message
99 P,TIMESTAMP
100 T,TIMESTAMP
101
102 The 'S' command checks to see if there is a playable audio file with
103 the specified name, and if so, clear's the generator's playlist and
104 places the file onto the list. Note that the playability check does
105 not take into account transcoding requirements, so it is possible for
106 the file to not be played even though it was found. If the file does
107 not exist it sends a Z response with the data element set to the file
108 requested. If the generator is not currently playing silence, then T
109 and D events will be sent to the child to signal the playlist
110 interruption and notify it of the files that will not be played.
111
112 The 'A' command checks to see if there is a playable audio file with
113 the specified name, and if so, adds it to the generator's
114 playlist. The same playability and exception rules apply as for the
115 'S' command.
116
117 The 'E' command stops the generator and continues execution in the dialplan,
118 and logs the supplied message to the Asterisk log.
119
120 The 'H' command stops the generator and hangs up the channel, and logs
121 the supplied message to the Asterisk log.
122
123 The 'O' command allows the child to set/clear options in the
124 ExternalIVR() application. The supported options are:
125         autoclear/noautoclear:
126         Automatically interrupt and clear the playlist upon reception
127         of DTMF input.
128
129 The 'T' command will answer and unanswered channel.  If it fails either
130 answering the channel or starting the generator it sends a Z response
131 of "Z,TIMESTAMP,ANSWER_FAILED" or "Z,TIMESTAMP,GENERATOR_FAILED"
132 respectively.
133
134 The 'V' command sets the specified channel variable(s) to the specified
135 value(s).
136
137 The 'G' command gets the specified channel variable(s).  Multiple
138 variables are separated by commas.  Response is in name=value format.
139
140 The 'P' command gets the parameters passed into ExternalIVR() minus
141 the options to ExternalIVR() itself:
142         If ExternalIVR() is executed as:
143                 ExternalIVR(/usr/bin/foo(arg1,arg2),n)
144         The response to the 'P' command would be:
145                 P,TIMESTAMP,/usr/bin/foo|arg1|arg2
146
147 The 'L' command puts a message into the Asterisk log.
148
149 Errors
150 ------
151
152 Any newline-terminated output generated by the child process on its
153 stderr handle will be copied into the Asterisk log.