a9ac72e399361af70855ded49ef8be5be05c1879
[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 };
72 /*!
73  * \brief Create a new channel (originate).
74  *
75  * 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.
76  *
77  * \param headers HTTP headers
78  * \param args Swagger parameters
79  * \param[out] response HTTP response
80  */
81 void ast_ari_channels_originate(struct ast_variable *headers, struct ast_ari_channels_originate_args *args, struct ast_ari_response *response);
82 /*! \brief Argument struct for ast_ari_channels_get() */
83 struct ast_ari_channels_get_args {
84         /*! \brief Channel's id */
85         const char *channel_id;
86 };
87 /*!
88  * \brief Channel details.
89  *
90  * \param headers HTTP headers
91  * \param args Swagger parameters
92  * \param[out] response HTTP response
93  */
94 void ast_ari_channels_get(struct ast_variable *headers, struct ast_ari_channels_get_args *args, struct ast_ari_response *response);
95 /*! \brief Argument struct for ast_ari_channels_hangup() */
96 struct ast_ari_channels_hangup_args {
97         /*! \brief Channel's id */
98         const char *channel_id;
99         /*! \brief Reason for hanging up the channel */
100         const char *reason;
101 };
102 /*!
103  * \brief Delete (i.e. hangup) a channel.
104  *
105  * \param headers HTTP headers
106  * \param args Swagger parameters
107  * \param[out] response HTTP response
108  */
109 void ast_ari_channels_hangup(struct ast_variable *headers, struct ast_ari_channels_hangup_args *args, struct ast_ari_response *response);
110 /*! \brief Argument struct for ast_ari_channels_continue_in_dialplan() */
111 struct ast_ari_channels_continue_in_dialplan_args {
112         /*! \brief Channel's id */
113         const char *channel_id;
114         /*! \brief The context to continue to. */
115         const char *context;
116         /*! \brief The extension to continue to. */
117         const char *extension;
118         /*! \brief The priority to continue to. */
119         int priority;
120 };
121 /*!
122  * \brief Exit application; continue execution in the dialplan.
123  *
124  * \param headers HTTP headers
125  * \param args Swagger parameters
126  * \param[out] response HTTP response
127  */
128 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);
129 /*! \brief Argument struct for ast_ari_channels_answer() */
130 struct ast_ari_channels_answer_args {
131         /*! \brief Channel's id */
132         const char *channel_id;
133 };
134 /*!
135  * \brief Answer a channel.
136  *
137  * \param headers HTTP headers
138  * \param args Swagger parameters
139  * \param[out] response HTTP response
140  */
141 void ast_ari_channels_answer(struct ast_variable *headers, struct ast_ari_channels_answer_args *args, struct ast_ari_response *response);
142 /*! \brief Argument struct for ast_ari_channels_ring() */
143 struct ast_ari_channels_ring_args {
144         /*! \brief Channel's id */
145         const char *channel_id;
146 };
147 /*!
148  * \brief Indicate ringing to a channel.
149  *
150  * \param headers HTTP headers
151  * \param args Swagger parameters
152  * \param[out] response HTTP response
153  */
154 void ast_ari_channels_ring(struct ast_variable *headers, struct ast_ari_channels_ring_args *args, struct ast_ari_response *response);
155 /*! \brief Argument struct for ast_ari_channels_ring_stop() */
156 struct ast_ari_channels_ring_stop_args {
157         /*! \brief Channel's id */
158         const char *channel_id;
159 };
160 /*!
161  * \brief Stop ringing indication on a channel if locally generated.
162  *
163  * \param headers HTTP headers
164  * \param args Swagger parameters
165  * \param[out] response HTTP response
166  */
167 void ast_ari_channels_ring_stop(struct ast_variable *headers, struct ast_ari_channels_ring_stop_args *args, struct ast_ari_response *response);
168 /*! \brief Argument struct for ast_ari_channels_send_dtmf() */
169 struct ast_ari_channels_send_dtmf_args {
170         /*! \brief Channel's id */
171         const char *channel_id;
172         /*! \brief DTMF To send. */
173         const char *dtmf;
174         /*! \brief Amount of time to wait before DTMF digits (specified in milliseconds) start. */
175         int before;
176         /*! \brief Amount of time in between DTMF digits (specified in milliseconds). */
177         int between;
178         /*! \brief Length of each DTMF digit (specified in milliseconds). */
179         int duration;
180         /*! \brief Amount of time to wait after DTMF digits (specified in milliseconds) end. */
181         int after;
182 };
183 /*!
184  * \brief Send provided DTMF to a given channel.
185  *
186  * \param headers HTTP headers
187  * \param args Swagger parameters
188  * \param[out] response HTTP response
189  */
190 void ast_ari_channels_send_dtmf(struct ast_variable *headers, struct ast_ari_channels_send_dtmf_args *args, struct ast_ari_response *response);
191 /*! \brief Argument struct for ast_ari_channels_mute() */
192 struct ast_ari_channels_mute_args {
193         /*! \brief Channel's id */
194         const char *channel_id;
195         /*! \brief Direction in which to mute audio */
196         const char *direction;
197 };
198 /*!
199  * \brief Mute a channel.
200  *
201  * \param headers HTTP headers
202  * \param args Swagger parameters
203  * \param[out] response HTTP response
204  */
205 void ast_ari_channels_mute(struct ast_variable *headers, struct ast_ari_channels_mute_args *args, struct ast_ari_response *response);
206 /*! \brief Argument struct for ast_ari_channels_unmute() */
207 struct ast_ari_channels_unmute_args {
208         /*! \brief Channel's id */
209         const char *channel_id;
210         /*! \brief Direction in which to unmute audio */
211         const char *direction;
212 };
213 /*!
214  * \brief Unmute a channel.
215  *
216  * \param headers HTTP headers
217  * \param args Swagger parameters
218  * \param[out] response HTTP response
219  */
220 void ast_ari_channels_unmute(struct ast_variable *headers, struct ast_ari_channels_unmute_args *args, struct ast_ari_response *response);
221 /*! \brief Argument struct for ast_ari_channels_hold() */
222 struct ast_ari_channels_hold_args {
223         /*! \brief Channel's id */
224         const char *channel_id;
225 };
226 /*!
227  * \brief Hold a channel.
228  *
229  * \param headers HTTP headers
230  * \param args Swagger parameters
231  * \param[out] response HTTP response
232  */
233 void ast_ari_channels_hold(struct ast_variable *headers, struct ast_ari_channels_hold_args *args, struct ast_ari_response *response);
234 /*! \brief Argument struct for ast_ari_channels_unhold() */
235 struct ast_ari_channels_unhold_args {
236         /*! \brief Channel's id */
237         const char *channel_id;
238 };
239 /*!
240  * \brief Remove a channel from hold.
241  *
242  * \param headers HTTP headers
243  * \param args Swagger parameters
244  * \param[out] response HTTP response
245  */
246 void ast_ari_channels_unhold(struct ast_variable *headers, struct ast_ari_channels_unhold_args *args, struct ast_ari_response *response);
247 /*! \brief Argument struct for ast_ari_channels_start_moh() */
248 struct ast_ari_channels_start_moh_args {
249         /*! \brief Channel's id */
250         const char *channel_id;
251         /*! \brief Music on hold class to use */
252         const char *moh_class;
253 };
254 /*!
255  * \brief Play music on hold to a channel.
256  *
257  * 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.
258  *
259  * \param headers HTTP headers
260  * \param args Swagger parameters
261  * \param[out] response HTTP response
262  */
263 void ast_ari_channels_start_moh(struct ast_variable *headers, struct ast_ari_channels_start_moh_args *args, struct ast_ari_response *response);
264 /*! \brief Argument struct for ast_ari_channels_stop_moh() */
265 struct ast_ari_channels_stop_moh_args {
266         /*! \brief Channel's id */
267         const char *channel_id;
268 };
269 /*!
270  * \brief Stop playing music on hold to a channel.
271  *
272  * \param headers HTTP headers
273  * \param args Swagger parameters
274  * \param[out] response HTTP response
275  */
276 void ast_ari_channels_stop_moh(struct ast_variable *headers, struct ast_ari_channels_stop_moh_args *args, struct ast_ari_response *response);
277 /*! \brief Argument struct for ast_ari_channels_start_silence() */
278 struct ast_ari_channels_start_silence_args {
279         /*! \brief Channel's id */
280         const char *channel_id;
281 };
282 /*!
283  * \brief Play silence to a channel.
284  *
285  * Using media operations such as /play on a channel playing silence in this manner will suspend silence without resuming automatically.
286  *
287  * \param headers HTTP headers
288  * \param args Swagger parameters
289  * \param[out] response HTTP response
290  */
291 void ast_ari_channels_start_silence(struct ast_variable *headers, struct ast_ari_channels_start_silence_args *args, struct ast_ari_response *response);
292 /*! \brief Argument struct for ast_ari_channels_stop_silence() */
293 struct ast_ari_channels_stop_silence_args {
294         /*! \brief Channel's id */
295         const char *channel_id;
296 };
297 /*!
298  * \brief Stop playing silence to a channel.
299  *
300  * \param headers HTTP headers
301  * \param args Swagger parameters
302  * \param[out] response HTTP response
303  */
304 void ast_ari_channels_stop_silence(struct ast_variable *headers, struct ast_ari_channels_stop_silence_args *args, struct ast_ari_response *response);
305 /*! \brief Argument struct for ast_ari_channels_play() */
306 struct ast_ari_channels_play_args {
307         /*! \brief Channel's id */
308         const char *channel_id;
309         /*! \brief Media's URI to play. */
310         const char *media;
311         /*! \brief For sounds, selects language for sound. */
312         const char *lang;
313         /*! \brief Number of media to skip before playing. */
314         int offsetms;
315         /*! \brief Number of milliseconds to skip for forward/reverse operations. */
316         int skipms;
317 };
318 /*!
319  * \brief Start playback of media.
320  *
321  * 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.)
322  *
323  * \param headers HTTP headers
324  * \param args Swagger parameters
325  * \param[out] response HTTP response
326  */
327 void ast_ari_channels_play(struct ast_variable *headers, struct ast_ari_channels_play_args *args, struct ast_ari_response *response);
328 /*! \brief Argument struct for ast_ari_channels_record() */
329 struct ast_ari_channels_record_args {
330         /*! \brief Channel's id */
331         const char *channel_id;
332         /*! \brief Recording's filename */
333         const char *name;
334         /*! \brief Format to encode audio in */
335         const char *format;
336         /*! \brief Maximum duration of the recording, in seconds. 0 for no limit */
337         int max_duration_seconds;
338         /*! \brief Maximum duration of silence, in seconds. 0 for no limit */
339         int max_silence_seconds;
340         /*! \brief Action to take if a recording with the same name already exists. */
341         const char *if_exists;
342         /*! \brief Play beep when recording begins */
343         int beep;
344         /*! \brief DTMF input to terminate recording */
345         const char *terminate_on;
346 };
347 /*!
348  * \brief Start a recording.
349  *
350  * 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.
351  *
352  * \param headers HTTP headers
353  * \param args Swagger parameters
354  * \param[out] response HTTP response
355  */
356 void ast_ari_channels_record(struct ast_variable *headers, struct ast_ari_channels_record_args *args, struct ast_ari_response *response);
357 /*! \brief Argument struct for ast_ari_channels_get_channel_var() */
358 struct ast_ari_channels_get_channel_var_args {
359         /*! \brief Channel's id */
360         const char *channel_id;
361         /*! \brief The channel variable or function to get */
362         const char *variable;
363 };
364 /*!
365  * \brief Get the value of a channel variable or function.
366  *
367  * \param headers HTTP headers
368  * \param args Swagger parameters
369  * \param[out] response HTTP response
370  */
371 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);
372 /*! \brief Argument struct for ast_ari_channels_set_channel_var() */
373 struct ast_ari_channels_set_channel_var_args {
374         /*! \brief Channel's id */
375         const char *channel_id;
376         /*! \brief The channel variable or function to set */
377         const char *variable;
378         /*! \brief The value to set the variable to */
379         const char *value;
380 };
381 /*!
382  * \brief Set the value of a channel variable or function.
383  *
384  * \param headers HTTP headers
385  * \param args Swagger parameters
386  * \param[out] response HTTP response
387  */
388 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);
389
390 #endif /* _ASTERISK_RESOURCE_CHANNELS_H */