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