36c7339ba19fb9abce1220cf46aa6e12b4fd2a0c
[asterisk/asterisk.git] / res / ari / resource_channels.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2012 - 2013, Digium, Inc.
5  *
6  * David M. Lee, II <dlee@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief Generated file - declares stubs to be implemented in
22  * res/ari/resource_channels.c
23  *
24  * Channel resources
25  *
26  * \author David M. Lee, II <dlee@digium.com>
27  */
28
29 /*
30  * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
31  * !!!!!                               DO NOT EDIT                        !!!!!
32  * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
33  * This file is generated by a mustache template. Please see the original
34  * template in rest-api-templates/ari_resource.h.mustache
35  */
36
37 #ifndef _ASTERISK_RESOURCE_CHANNELS_H
38 #define _ASTERISK_RESOURCE_CHANNELS_H
39
40 #include "asterisk/ari.h"
41
42 /*! \brief Argument struct for ast_ari_channels_list() */
43 struct ast_ari_channels_list_args {
44 };
45 /*!
46  * \brief List all active channels in Asterisk.
47  *
48  * \param headers HTTP headers
49  * \param args Swagger parameters
50  * \param[out] response HTTP response
51  */
52 void ast_ari_channels_list(struct ast_variable *headers, struct ast_ari_channels_list_args *args, struct ast_ari_response *response);
53 /*! \brief Argument struct for ast_ari_channels_originate() */
54 struct ast_ari_channels_originate_args {
55         /*! \brief Endpoint to call. */
56         const char *endpoint;
57         /*! \brief The extension to dial after the endpoint answers */
58         const char *extension;
59         /*! \brief The context to dial after the endpoint answers. If omitted, uses 'default' */
60         const char *context;
61         /*! \brief The priority to dial after the endpoint answers. If omitted, uses 1 */
62         long priority;
63         /*! \brief The application that is subscribed to the originated channel, and passed to the Stasis application. */
64         const char *app;
65         /*! \brief The application arguments to pass to the Stasis application. */
66         const char *app_args;
67         /*! \brief CallerID to use when dialing the endpoint or extension. */
68         const char *caller_id;
69         /*! \brief Timeout (in seconds) before giving up dialing, or -1 for no timeout. */
70         int timeout;
71         /*! \brief Variables to be set on the channel. */
72         struct ast_json *variables;
73 };
74 /*!
75  * \brief Create a new channel (originate).
76  *
77  * The new channel is created immediately and a snapshot of it returned. If a Stasis application is provided it will be automatically subscribed to the originated channel for further events and updates.
78  *
79  * \param headers HTTP headers
80  * \param args Swagger parameters
81  * \param[out] response HTTP response
82  */
83 void ast_ari_channels_originate(struct ast_variable *headers, struct ast_ari_channels_originate_args *args, struct ast_ari_response *response);
84 /*! \brief Argument struct for ast_ari_channels_get() */
85 struct ast_ari_channels_get_args {
86         /*! \brief Channel's id */
87         const char *channel_id;
88 };
89 /*!
90  * \brief Channel details.
91  *
92  * \param headers HTTP headers
93  * \param args Swagger parameters
94  * \param[out] response HTTP response
95  */
96 void ast_ari_channels_get(struct ast_variable *headers, struct ast_ari_channels_get_args *args, struct ast_ari_response *response);
97 /*! \brief Argument struct for ast_ari_channels_hangup() */
98 struct ast_ari_channels_hangup_args {
99         /*! \brief Channel's id */
100         const char *channel_id;
101         /*! \brief Reason for hanging up the channel */
102         const char *reason;
103 };
104 /*!
105  * \brief Delete (i.e. hangup) a channel.
106  *
107  * \param headers HTTP headers
108  * \param args Swagger parameters
109  * \param[out] response HTTP response
110  */
111 void ast_ari_channels_hangup(struct ast_variable *headers, struct ast_ari_channels_hangup_args *args, struct ast_ari_response *response);
112 /*! \brief Argument struct for ast_ari_channels_continue_in_dialplan() */
113 struct ast_ari_channels_continue_in_dialplan_args {
114         /*! \brief Channel's id */
115         const char *channel_id;
116         /*! \brief The context to continue to. */
117         const char *context;
118         /*! \brief The extension to continue to. */
119         const char *extension;
120         /*! \brief The priority to continue to. */
121         int priority;
122 };
123 /*!
124  * \brief Exit application; continue execution in the dialplan.
125  *
126  * \param headers HTTP headers
127  * \param args Swagger parameters
128  * \param[out] response HTTP response
129  */
130 void ast_ari_channels_continue_in_dialplan(struct ast_variable *headers, struct ast_ari_channels_continue_in_dialplan_args *args, struct ast_ari_response *response);
131 /*! \brief Argument struct for ast_ari_channels_answer() */
132 struct ast_ari_channels_answer_args {
133         /*! \brief Channel's id */
134         const char *channel_id;
135 };
136 /*!
137  * \brief Answer a channel.
138  *
139  * \param headers HTTP headers
140  * \param args Swagger parameters
141  * \param[out] response HTTP response
142  */
143 void ast_ari_channels_answer(struct ast_variable *headers, struct ast_ari_channels_answer_args *args, struct ast_ari_response *response);
144 /*! \brief Argument struct for ast_ari_channels_ring() */
145 struct ast_ari_channels_ring_args {
146         /*! \brief Channel's id */
147         const char *channel_id;
148 };
149 /*!
150  * \brief Indicate ringing to a channel.
151  *
152  * \param headers HTTP headers
153  * \param args Swagger parameters
154  * \param[out] response HTTP response
155  */
156 void ast_ari_channels_ring(struct ast_variable *headers, struct ast_ari_channels_ring_args *args, struct ast_ari_response *response);
157 /*! \brief Argument struct for ast_ari_channels_ring_stop() */
158 struct ast_ari_channels_ring_stop_args {
159         /*! \brief Channel's id */
160         const char *channel_id;
161 };
162 /*!
163  * \brief Stop ringing indication on a channel if locally generated.
164  *
165  * \param headers HTTP headers
166  * \param args Swagger parameters
167  * \param[out] response HTTP response
168  */
169 void ast_ari_channels_ring_stop(struct ast_variable *headers, struct ast_ari_channels_ring_stop_args *args, struct ast_ari_response *response);
170 /*! \brief Argument struct for ast_ari_channels_send_dtmf() */
171 struct ast_ari_channels_send_dtmf_args {
172         /*! \brief Channel's id */
173         const char *channel_id;
174         /*! \brief DTMF To send. */
175         const char *dtmf;
176         /*! \brief Amount of time to wait before DTMF digits (specified in milliseconds) start. */
177         int before;
178         /*! \brief Amount of time in between DTMF digits (specified in milliseconds). */
179         int between;
180         /*! \brief Length of each DTMF digit (specified in milliseconds). */
181         int duration;
182         /*! \brief Amount of time to wait after DTMF digits (specified in milliseconds) end. */
183         int after;
184 };
185 /*!
186  * \brief Send provided DTMF to a given channel.
187  *
188  * \param headers HTTP headers
189  * \param args Swagger parameters
190  * \param[out] response HTTP response
191  */
192 void ast_ari_channels_send_dtmf(struct ast_variable *headers, struct ast_ari_channels_send_dtmf_args *args, struct ast_ari_response *response);
193 /*! \brief Argument struct for ast_ari_channels_mute() */
194 struct ast_ari_channels_mute_args {
195         /*! \brief Channel's id */
196         const char *channel_id;
197         /*! \brief Direction in which to mute audio */
198         const char *direction;
199 };
200 /*!
201  * \brief Mute a channel.
202  *
203  * \param headers HTTP headers
204  * \param args Swagger parameters
205  * \param[out] response HTTP response
206  */
207 void ast_ari_channels_mute(struct ast_variable *headers, struct ast_ari_channels_mute_args *args, struct ast_ari_response *response);
208 /*! \brief Argument struct for ast_ari_channels_unmute() */
209 struct ast_ari_channels_unmute_args {
210         /*! \brief Channel's id */
211         const char *channel_id;
212         /*! \brief Direction in which to unmute audio */
213         const char *direction;
214 };
215 /*!
216  * \brief Unmute a channel.
217  *
218  * \param headers HTTP headers
219  * \param args Swagger parameters
220  * \param[out] response HTTP response
221  */
222 void ast_ari_channels_unmute(struct ast_variable *headers, struct ast_ari_channels_unmute_args *args, struct ast_ari_response *response);
223 /*! \brief Argument struct for ast_ari_channels_hold() */
224 struct ast_ari_channels_hold_args {
225         /*! \brief Channel's id */
226         const char *channel_id;
227 };
228 /*!
229  * \brief Hold a channel.
230  *
231  * \param headers HTTP headers
232  * \param args Swagger parameters
233  * \param[out] response HTTP response
234  */
235 void ast_ari_channels_hold(struct ast_variable *headers, struct ast_ari_channels_hold_args *args, struct ast_ari_response *response);
236 /*! \brief Argument struct for ast_ari_channels_unhold() */
237 struct ast_ari_channels_unhold_args {
238         /*! \brief Channel's id */
239         const char *channel_id;
240 };
241 /*!
242  * \brief Remove a channel from hold.
243  *
244  * \param headers HTTP headers
245  * \param args Swagger parameters
246  * \param[out] response HTTP response
247  */
248 void ast_ari_channels_unhold(struct ast_variable *headers, struct ast_ari_channels_unhold_args *args, struct ast_ari_response *response);
249 /*! \brief Argument struct for ast_ari_channels_start_moh() */
250 struct ast_ari_channels_start_moh_args {
251         /*! \brief Channel's id */
252         const char *channel_id;
253         /*! \brief Music on hold class to use */
254         const char *moh_class;
255 };
256 /*!
257  * \brief Play music on hold to a channel.
258  *
259  * Using media operations such as /play on a channel playing MOH in this manner will suspend MOH without resuming automatically. If continuing music on hold is desired, the stasis application must reinitiate music on hold.
260  *
261  * \param headers HTTP headers
262  * \param args Swagger parameters
263  * \param[out] response HTTP response
264  */
265 void ast_ari_channels_start_moh(struct ast_variable *headers, struct ast_ari_channels_start_moh_args *args, struct ast_ari_response *response);
266 /*! \brief Argument struct for ast_ari_channels_stop_moh() */
267 struct ast_ari_channels_stop_moh_args {
268         /*! \brief Channel's id */
269         const char *channel_id;
270 };
271 /*!
272  * \brief Stop playing music on hold to a channel.
273  *
274  * \param headers HTTP headers
275  * \param args Swagger parameters
276  * \param[out] response HTTP response
277  */
278 void ast_ari_channels_stop_moh(struct ast_variable *headers, struct ast_ari_channels_stop_moh_args *args, struct ast_ari_response *response);
279 /*! \brief Argument struct for ast_ari_channels_start_silence() */
280 struct ast_ari_channels_start_silence_args {
281         /*! \brief Channel's id */
282         const char *channel_id;
283 };
284 /*!
285  * \brief Play silence to a channel.
286  *
287  * Using media operations such as /play on a channel playing silence in this manner will suspend silence without resuming automatically.
288  *
289  * \param headers HTTP headers
290  * \param args Swagger parameters
291  * \param[out] response HTTP response
292  */
293 void ast_ari_channels_start_silence(struct ast_variable *headers, struct ast_ari_channels_start_silence_args *args, struct ast_ari_response *response);
294 /*! \brief Argument struct for ast_ari_channels_stop_silence() */
295 struct ast_ari_channels_stop_silence_args {
296         /*! \brief Channel's id */
297         const char *channel_id;
298 };
299 /*!
300  * \brief Stop playing silence to a channel.
301  *
302  * \param headers HTTP headers
303  * \param args Swagger parameters
304  * \param[out] response HTTP response
305  */
306 void ast_ari_channels_stop_silence(struct ast_variable *headers, struct ast_ari_channels_stop_silence_args *args, struct ast_ari_response *response);
307 /*! \brief Argument struct for ast_ari_channels_play() */
308 struct ast_ari_channels_play_args {
309         /*! \brief Channel's id */
310         const char *channel_id;
311         /*! \brief Media's URI to play. */
312         const char *media;
313         /*! \brief For sounds, selects language for sound. */
314         const char *lang;
315         /*! \brief Number of media to skip before playing. */
316         int offsetms;
317         /*! \brief Number of milliseconds to skip for forward/reverse operations. */
318         int skipms;
319 };
320 /*!
321  * \brief Start playback of media.
322  *
323  * The media URI may be any of a number of URI's. Currently sound: and recording: URI's are supported. This operation creates a playback resource that can be used to control the playback of media (pause, rewind, fast forward, etc.)
324  *
325  * \param headers HTTP headers
326  * \param args Swagger parameters
327  * \param[out] response HTTP response
328  */
329 void ast_ari_channels_play(struct ast_variable *headers, struct ast_ari_channels_play_args *args, struct ast_ari_response *response);
330 /*! \brief Argument struct for ast_ari_channels_record() */
331 struct ast_ari_channels_record_args {
332         /*! \brief Channel's id */
333         const char *channel_id;
334         /*! \brief Recording's filename */
335         const char *name;
336         /*! \brief Format to encode audio in */
337         const char *format;
338         /*! \brief Maximum duration of the recording, in seconds. 0 for no limit */
339         int max_duration_seconds;
340         /*! \brief Maximum duration of silence, in seconds. 0 for no limit */
341         int max_silence_seconds;
342         /*! \brief Action to take if a recording with the same name already exists. */
343         const char *if_exists;
344         /*! \brief Play beep when recording begins */
345         int beep;
346         /*! \brief DTMF input to terminate recording */
347         const char *terminate_on;
348 };
349 /*!
350  * \brief Start a recording.
351  *
352  * Record audio from a channel. Note that this will not capture audio sent to the channel. The bridge itself has a record feature if that's what you want.
353  *
354  * \param headers HTTP headers
355  * \param args Swagger parameters
356  * \param[out] response HTTP response
357  */
358 void ast_ari_channels_record(struct ast_variable *headers, struct ast_ari_channels_record_args *args, struct ast_ari_response *response);
359 /*! \brief Argument struct for ast_ari_channels_get_channel_var() */
360 struct ast_ari_channels_get_channel_var_args {
361         /*! \brief Channel's id */
362         const char *channel_id;
363         /*! \brief The channel variable or function to get */
364         const char *variable;
365 };
366 /*!
367  * \brief Get the value of a channel variable or function.
368  *
369  * \param headers HTTP headers
370  * \param args Swagger parameters
371  * \param[out] response HTTP response
372  */
373 void ast_ari_channels_get_channel_var(struct ast_variable *headers, struct ast_ari_channels_get_channel_var_args *args, struct ast_ari_response *response);
374 /*! \brief Argument struct for ast_ari_channels_set_channel_var() */
375 struct ast_ari_channels_set_channel_var_args {
376         /*! \brief Channel's id */
377         const char *channel_id;
378         /*! \brief The channel variable or function to set */
379         const char *variable;
380         /*! \brief The value to set the variable to */
381         const char *value;
382 };
383 /*!
384  * \brief Set the value of a channel variable or function.
385  *
386  * \param headers HTTP headers
387  * \param args Swagger parameters
388  * \param[out] response HTTP response
389  */
390 void ast_ari_channels_set_channel_var(struct ast_variable *headers, struct ast_ari_channels_set_channel_var_args *args, struct ast_ari_response *response);
391 /*! \brief Argument struct for ast_ari_channels_snoop_channel() */
392 struct ast_ari_channels_snoop_channel_args {
393         /*! \brief Channel's id */
394         const char *channel_id;
395         /*! \brief Direction of audio to spy on */
396         const char *spy;
397         /*! \brief Direction of audio to whisper into */
398         const char *whisper;
399         /*! \brief Application the snooping channel is placed into */
400         const char *app;
401         /*! \brief The application arguments to pass to the Stasis application */
402         const char *app_args;
403 };
404 /*!
405  * \brief Start snooping.
406  *
407  * Snoop (spy/whisper) on a specific channel.
408  *
409  * \param headers HTTP headers
410  * \param args Swagger parameters
411  * \param[out] response HTTP response
412  */
413 void ast_ari_channels_snoop_channel(struct ast_variable *headers, struct ast_ari_channels_snoop_channel_args *args, struct ast_ari_response *response);
414
415 #endif /* _ASTERISK_RESOURCE_CHANNELS_H */