d7d1dd0dbdf3a09bbf0efb0628871b05b5fabbe2
[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 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_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 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_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_continue_in_dialplan() */
109 struct ast_continue_in_dialplan_args {
110         /*! \brief Channel's id */
111         const char *channel_id;
112         /*! \brief The context to continue to. */
113         const char *context;
114         /*! \brief The extension to continue to. */
115         const char *extension;
116         /*! \brief The priority to continue to. */
117         int priority;
118 };
119 /*!
120  * \brief Exit application; continue execution in the dialplan.
121  *
122  * \param headers HTTP headers
123  * \param args Swagger parameters
124  * \param[out] response HTTP response
125  */
126 void ast_ari_continue_in_dialplan(struct ast_variable *headers, struct ast_continue_in_dialplan_args *args, struct ast_ari_response *response);
127 /*! \brief Argument struct for ast_ari_answer_channel() */
128 struct ast_answer_channel_args {
129         /*! \brief Channel's id */
130         const char *channel_id;
131 };
132 /*!
133  * \brief Answer a channel.
134  *
135  * \param headers HTTP headers
136  * \param args Swagger parameters
137  * \param[out] response HTTP response
138  */
139 void ast_ari_answer_channel(struct ast_variable *headers, struct ast_answer_channel_args *args, struct ast_ari_response *response);
140 /*! \brief Argument struct for ast_ari_mute_channel() */
141 struct ast_mute_channel_args {
142         /*! \brief Channel's id */
143         const char *channel_id;
144         /*! \brief Direction in which to mute audio */
145         const char *direction;
146 };
147 /*!
148  * \brief Mute a channel.
149  *
150  * \param headers HTTP headers
151  * \param args Swagger parameters
152  * \param[out] response HTTP response
153  */
154 void ast_ari_mute_channel(struct ast_variable *headers, struct ast_mute_channel_args *args, struct ast_ari_response *response);
155 /*! \brief Argument struct for ast_ari_unmute_channel() */
156 struct ast_unmute_channel_args {
157         /*! \brief Channel's id */
158         const char *channel_id;
159         /*! \brief Direction in which to unmute audio */
160         const char *direction;
161 };
162 /*!
163  * \brief Unmute a channel.
164  *
165  * \param headers HTTP headers
166  * \param args Swagger parameters
167  * \param[out] response HTTP response
168  */
169 void ast_ari_unmute_channel(struct ast_variable *headers, struct ast_unmute_channel_args *args, struct ast_ari_response *response);
170 /*! \brief Argument struct for ast_ari_hold_channel() */
171 struct ast_hold_channel_args {
172         /*! \brief Channel's id */
173         const char *channel_id;
174 };
175 /*!
176  * \brief Hold a channel.
177  *
178  * \param headers HTTP headers
179  * \param args Swagger parameters
180  * \param[out] response HTTP response
181  */
182 void ast_ari_hold_channel(struct ast_variable *headers, struct ast_hold_channel_args *args, struct ast_ari_response *response);
183 /*! \brief Argument struct for ast_ari_unhold_channel() */
184 struct ast_unhold_channel_args {
185         /*! \brief Channel's id */
186         const char *channel_id;
187 };
188 /*!
189  * \brief Remove a channel from hold.
190  *
191  * \param headers HTTP headers
192  * \param args Swagger parameters
193  * \param[out] response HTTP response
194  */
195 void ast_ari_unhold_channel(struct ast_variable *headers, struct ast_unhold_channel_args *args, struct ast_ari_response *response);
196 /*! \brief Argument struct for ast_ari_moh_start_channel() */
197 struct ast_moh_start_channel_args {
198         /*! \brief Channel's id */
199         const char *channel_id;
200         /*! \brief Music on hold class to use */
201         const char *moh_class;
202 };
203 /*!
204  * \brief Play music on hold to a channel.
205  *
206  * 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.
207  *
208  * \param headers HTTP headers
209  * \param args Swagger parameters
210  * \param[out] response HTTP response
211  */
212 void ast_ari_moh_start_channel(struct ast_variable *headers, struct ast_moh_start_channel_args *args, struct ast_ari_response *response);
213 /*! \brief Argument struct for ast_ari_moh_stop_channel() */
214 struct ast_moh_stop_channel_args {
215         /*! \brief Channel's id */
216         const char *channel_id;
217 };
218 /*!
219  * \brief Stop playing music on hold to a channel.
220  *
221  * \param headers HTTP headers
222  * \param args Swagger parameters
223  * \param[out] response HTTP response
224  */
225 void ast_ari_moh_stop_channel(struct ast_variable *headers, struct ast_moh_stop_channel_args *args, struct ast_ari_response *response);
226 /*! \brief Argument struct for ast_ari_play_on_channel() */
227 struct ast_play_on_channel_args {
228         /*! \brief Channel's id */
229         const char *channel_id;
230         /*! \brief Media's URI to play. */
231         const char *media;
232         /*! \brief For sounds, selects language for sound. */
233         const char *lang;
234         /*! \brief Number of media to skip before playing. */
235         int offsetms;
236         /*! \brief Number of milliseconds to skip for forward/reverse operations. */
237         int skipms;
238 };
239 /*!
240  * \brief Start playback of media.
241  *
242  * 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.)
243  *
244  * \param headers HTTP headers
245  * \param args Swagger parameters
246  * \param[out] response HTTP response
247  */
248 void ast_ari_play_on_channel(struct ast_variable *headers, struct ast_play_on_channel_args *args, struct ast_ari_response *response);
249 /*! \brief Argument struct for ast_ari_record_channel() */
250 struct ast_record_channel_args {
251         /*! \brief Channel's id */
252         const char *channel_id;
253         /*! \brief Recording's filename */
254         const char *name;
255         /*! \brief Format to encode audio in */
256         const char *format;
257         /*! \brief Maximum duration of the recording, in seconds. 0 for no limit */
258         int max_duration_seconds;
259         /*! \brief Maximum duration of silence, in seconds. 0 for no limit */
260         int max_silence_seconds;
261         /*! \brief Action to take if a recording with the same name already exists. */
262         const char *if_exists;
263         /*! \brief Play beep when recording begins */
264         int beep;
265         /*! \brief DTMF input to terminate recording */
266         const char *terminate_on;
267 };
268 /*!
269  * \brief Start a recording.
270  *
271  * 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.
272  *
273  * \param headers HTTP headers
274  * \param args Swagger parameters
275  * \param[out] response HTTP response
276  */
277 void ast_ari_record_channel(struct ast_variable *headers, struct ast_record_channel_args *args, struct ast_ari_response *response);
278 /*! \brief Argument struct for ast_ari_get_channel_var() */
279 struct ast_get_channel_var_args {
280         /*! \brief Channel's id */
281         const char *channel_id;
282         /*! \brief The channel variable or function to get */
283         const char *variable;
284 };
285 /*!
286  * \brief Get the value of a channel variable or function.
287  *
288  * \param headers HTTP headers
289  * \param args Swagger parameters
290  * \param[out] response HTTP response
291  */
292 void ast_ari_get_channel_var(struct ast_variable *headers, struct ast_get_channel_var_args *args, struct ast_ari_response *response);
293 /*! \brief Argument struct for ast_ari_set_channel_var() */
294 struct ast_set_channel_var_args {
295         /*! \brief Channel's id */
296         const char *channel_id;
297         /*! \brief The channel variable or function to set */
298         const char *variable;
299         /*! \brief The value to set the variable to */
300         const char *value;
301 };
302 /*!
303  * \brief Set the value of a channel variable or function.
304  *
305  * \param headers HTTP headers
306  * \param args Swagger parameters
307  * \param[out] response HTTP response
308  */
309 void ast_ari_set_channel_var(struct ast_variable *headers, struct ast_set_channel_var_args *args, struct ast_ari_response *response);
310
311 #endif /* _ASTERISK_RESOURCE_CHANNELS_H */