Multiple revisions 398638-398639
[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_get_channels() */
43 struct ast_get_channels_args {
44 };
45 /*!
46  * \brief List active channels.
47  *
48  * \param headers HTTP headers
49  * \param args Swagger parameters
50  * \param[out] response HTTP response
51  */
52 void ast_ari_get_channels(struct ast_variable *headers, struct ast_get_channels_args *args, struct ast_ari_response *response);
53 /*! \brief Argument struct for ast_ari_originate() */
54 struct ast_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 name to pass 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 not created until the dialed party picks up. Not wanting to block this request indefinitely, this request returns immediately with a 204 No Content. When the channel is created, a StasisStart event is sent with the provided app and appArgs. In the event of a failure (timeout, busy, etc.), an OriginationFailed event is sent.
76  *
77  * \param headers HTTP headers
78  * \param args Swagger parameters
79  * \param[out] response HTTP response
80  */
81 void ast_ari_originate(struct ast_variable *headers, struct ast_originate_args *args, struct ast_ari_response *response);
82 /*! \brief Argument struct for ast_ari_get_channel() */
83 struct ast_get_channel_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_get_channel(struct ast_variable *headers, struct ast_get_channel_args *args, struct ast_ari_response *response);
95 /*! \brief Argument struct for ast_ari_delete_channel() */
96 struct ast_delete_channel_args {
97         /*! \brief Channel's id */
98         const char *channel_id;
99 };
100 /*!
101  * \brief Delete (i.e. hangup) a channel.
102  *
103  * \param headers HTTP headers
104  * \param args Swagger parameters
105  * \param[out] response HTTP response
106  */
107 void ast_ari_delete_channel(struct ast_variable *headers, struct ast_delete_channel_args *args, struct ast_ari_response *response);
108 /*! \brief Argument struct for ast_ari_dial() */
109 struct ast_dial_args {
110         /*! \brief Channel's id */
111         const char *channel_id;
112         /*! \brief Endpoint to call. If not specified, dial is routed via dialplan */
113         const char *endpoint;
114         /*! \brief Extension to dial */
115         const char *extension;
116         /*! \brief When routing via dialplan, the context use. If omitted, uses 'default' */
117         const char *context;
118         /*! \brief Timeout (in seconds) before giving up dialing, or -1 for no timeout. */
119         int timeout;
120 };
121 /*!
122  * \brief Create a new channel (originate) and bridge to this channel.
123  *
124  * \param headers HTTP headers
125  * \param args Swagger parameters
126  * \param[out] response HTTP response
127  */
128 void ast_ari_dial(struct ast_variable *headers, struct ast_dial_args *args, struct ast_ari_response *response);
129 /*! \brief Argument struct for ast_ari_continue_in_dialplan() */
130 struct ast_continue_in_dialplan_args {
131         /*! \brief Channel's id */
132         const char *channel_id;
133         /*! \brief The context to continue to. */
134         const char *context;
135         /*! \brief The extension to continue to. */
136         const char *extension;
137         /*! \brief The priority to continue to. */
138         int priority;
139 };
140 /*!
141  * \brief Exit application; continue execution in the dialplan.
142  *
143  * \param headers HTTP headers
144  * \param args Swagger parameters
145  * \param[out] response HTTP response
146  */
147 void ast_ari_continue_in_dialplan(struct ast_variable *headers, struct ast_continue_in_dialplan_args *args, struct ast_ari_response *response);
148 /*! \brief Argument struct for ast_ari_answer_channel() */
149 struct ast_answer_channel_args {
150         /*! \brief Channel's id */
151         const char *channel_id;
152 };
153 /*!
154  * \brief Answer a channel.
155  *
156  * \param headers HTTP headers
157  * \param args Swagger parameters
158  * \param[out] response HTTP response
159  */
160 void ast_ari_answer_channel(struct ast_variable *headers, struct ast_answer_channel_args *args, struct ast_ari_response *response);
161 /*! \brief Argument struct for ast_ari_mute_channel() */
162 struct ast_mute_channel_args {
163         /*! \brief Channel's id */
164         const char *channel_id;
165         /*! \brief Direction in which to mute audio */
166         const char *direction;
167 };
168 /*!
169  * \brief Mute a channel.
170  *
171  * \param headers HTTP headers
172  * \param args Swagger parameters
173  * \param[out] response HTTP response
174  */
175 void ast_ari_mute_channel(struct ast_variable *headers, struct ast_mute_channel_args *args, struct ast_ari_response *response);
176 /*! \brief Argument struct for ast_ari_unmute_channel() */
177 struct ast_unmute_channel_args {
178         /*! \brief Channel's id */
179         const char *channel_id;
180         /*! \brief Direction in which to unmute audio */
181         const char *direction;
182 };
183 /*!
184  * \brief Unmute a channel.
185  *
186  * \param headers HTTP headers
187  * \param args Swagger parameters
188  * \param[out] response HTTP response
189  */
190 void ast_ari_unmute_channel(struct ast_variable *headers, struct ast_unmute_channel_args *args, struct ast_ari_response *response);
191 /*! \brief Argument struct for ast_ari_hold_channel() */
192 struct ast_hold_channel_args {
193         /*! \brief Channel's id */
194         const char *channel_id;
195 };
196 /*!
197  * \brief Hold a channel.
198  *
199  * \param headers HTTP headers
200  * \param args Swagger parameters
201  * \param[out] response HTTP response
202  */
203 void ast_ari_hold_channel(struct ast_variable *headers, struct ast_hold_channel_args *args, struct ast_ari_response *response);
204 /*! \brief Argument struct for ast_ari_unhold_channel() */
205 struct ast_unhold_channel_args {
206         /*! \brief Channel's id */
207         const char *channel_id;
208 };
209 /*!
210  * \brief Remove a channel from hold.
211  *
212  * \param headers HTTP headers
213  * \param args Swagger parameters
214  * \param[out] response HTTP response
215  */
216 void ast_ari_unhold_channel(struct ast_variable *headers, struct ast_unhold_channel_args *args, struct ast_ari_response *response);
217 /*! \brief Argument struct for ast_ari_moh_start_channel() */
218 struct ast_moh_start_channel_args {
219         /*! \brief Channel's id */
220         const char *channel_id;
221         /*! \brief Music on hold class to use */
222         const char *moh_class;
223 };
224 /*!
225  * \brief Play music on hold to a channel.
226  *
227  * Using media operations such as playOnChannel 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.
228  *
229  * \param headers HTTP headers
230  * \param args Swagger parameters
231  * \param[out] response HTTP response
232  */
233 void ast_ari_moh_start_channel(struct ast_variable *headers, struct ast_moh_start_channel_args *args, struct ast_ari_response *response);
234 /*! \brief Argument struct for ast_ari_moh_stop_channel() */
235 struct ast_moh_stop_channel_args {
236         /*! \brief Channel's id */
237         const char *channel_id;
238 };
239 /*!
240  * \brief Stop playing music on hold to a channel.
241  *
242  * \param headers HTTP headers
243  * \param args Swagger parameters
244  * \param[out] response HTTP response
245  */
246 void ast_ari_moh_stop_channel(struct ast_variable *headers, struct ast_moh_stop_channel_args *args, struct ast_ari_response *response);
247 /*! \brief Argument struct for ast_ari_play_on_channel() */
248 struct ast_play_on_channel_args {
249         /*! \brief Channel's id */
250         const char *channel_id;
251         /*! \brief Media's URI to play. */
252         const char *media;
253         /*! \brief For sounds, selects language for sound. */
254         const char *lang;
255         /*! \brief Number of media to skip before playing. */
256         int offsetms;
257         /*! \brief Number of milliseconds to skip for forward/reverse operations. */
258         int skipms;
259 };
260 /*!
261  * \brief Start playback of media.
262  *
263  * The media URI may be any of a number of URI's. You may use http: and https: URI's, as well as sound: and recording: URI's. This operation creates a playback resource that can be used to control the playback of media (pause, rewind, fast forward, etc.)
264  *
265  * \param headers HTTP headers
266  * \param args Swagger parameters
267  * \param[out] response HTTP response
268  */
269 void ast_ari_play_on_channel(struct ast_variable *headers, struct ast_play_on_channel_args *args, struct ast_ari_response *response);
270 /*! \brief Argument struct for ast_ari_record_channel() */
271 struct ast_record_channel_args {
272         /*! \brief Channel's id */
273         const char *channel_id;
274         /*! \brief Recording's filename */
275         const char *name;
276         /*! \brief Format to encode audio in */
277         const char *format;
278         /*! \brief Maximum duration of the recording, in seconds. 0 for no limit */
279         int max_duration_seconds;
280         /*! \brief Maximum duration of silence, in seconds. 0 for no limit */
281         int max_silence_seconds;
282         /*! \brief Action to take if a recording with the same name already exists. */
283         const char *if_exists;
284         /*! \brief Play beep when recording begins */
285         int beep;
286         /*! \brief DTMF input to terminate recording */
287         const char *terminate_on;
288 };
289 /*!
290  * \brief Start a recording.
291  *
292  * 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.
293  *
294  * \param headers HTTP headers
295  * \param args Swagger parameters
296  * \param[out] response HTTP response
297  */
298 void ast_ari_record_channel(struct ast_variable *headers, struct ast_record_channel_args *args, struct ast_ari_response *response);
299 /*! \brief Argument struct for ast_ari_get_channel_var() */
300 struct ast_get_channel_var_args {
301         /*! \brief Channel's id */
302         const char *channel_id;
303         /*! \brief The channel variable or function to get */
304         const char *variable;
305 };
306 /*!
307  * \brief Get the value of a channel variable or function.
308  *
309  * \param headers HTTP headers
310  * \param args Swagger parameters
311  * \param[out] response HTTP response
312  */
313 void ast_ari_get_channel_var(struct ast_variable *headers, struct ast_get_channel_var_args *args, struct ast_ari_response *response);
314 /*! \brief Argument struct for ast_ari_set_channel_var() */
315 struct ast_set_channel_var_args {
316         /*! \brief Channel's id */
317         const char *channel_id;
318         /*! \brief The channel variable or function to set */
319         const char *variable;
320         /*! \brief The value to set the variable to */
321         const char *value;
322 };
323 /*!
324  * \brief Set the value of a channel variable or function.
325  *
326  * \param headers HTTP headers
327  * \param args Swagger parameters
328  * \param[out] response HTTP response
329  */
330 void ast_ari_set_channel_var(struct ast_variable *headers, struct ast_set_channel_var_args *args, struct ast_ari_response *response);
331
332 #endif /* _ASTERISK_RESOURCE_CHANNELS_H */