ari endpoints: GET /ari/endpoints/{invalid-tech} should return a 404
[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_send_dtmf() */
156 struct ast_ari_channels_send_dtmf_args {
157         /*! \brief Channel's id */
158         const char *channel_id;
159         /*! \brief DTMF To send. */
160         const char *dtmf;
161         /*! \brief Amount of time to wait before DTMF digits (specified in milliseconds) start. */
162         int before;
163         /*! \brief Amount of time in between DTMF digits (specified in milliseconds). */
164         int between;
165         /*! \brief Length of each DTMF digit (specified in milliseconds). */
166         int duration;
167         /*! \brief Amount of time to wait after DTMF digits (specified in milliseconds) end. */
168         int after;
169 };
170 /*!
171  * \brief Send provided DTMF to a given channel.
172  *
173  * \param headers HTTP headers
174  * \param args Swagger parameters
175  * \param[out] response HTTP response
176  */
177 void ast_ari_channels_send_dtmf(struct ast_variable *headers, struct ast_ari_channels_send_dtmf_args *args, struct ast_ari_response *response);
178 /*! \brief Argument struct for ast_ari_channels_mute() */
179 struct ast_ari_channels_mute_args {
180         /*! \brief Channel's id */
181         const char *channel_id;
182         /*! \brief Direction in which to mute audio */
183         const char *direction;
184 };
185 /*!
186  * \brief Mute a channel.
187  *
188  * \param headers HTTP headers
189  * \param args Swagger parameters
190  * \param[out] response HTTP response
191  */
192 void ast_ari_channels_mute(struct ast_variable *headers, struct ast_ari_channels_mute_args *args, struct ast_ari_response *response);
193 /*! \brief Argument struct for ast_ari_channels_unmute() */
194 struct ast_ari_channels_unmute_args {
195         /*! \brief Channel's id */
196         const char *channel_id;
197         /*! \brief Direction in which to unmute audio */
198         const char *direction;
199 };
200 /*!
201  * \brief Unmute 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_unmute(struct ast_variable *headers, struct ast_ari_channels_unmute_args *args, struct ast_ari_response *response);
208 /*! \brief Argument struct for ast_ari_channels_hold() */
209 struct ast_ari_channels_hold_args {
210         /*! \brief Channel's id */
211         const char *channel_id;
212 };
213 /*!
214  * \brief Hold 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_hold(struct ast_variable *headers, struct ast_ari_channels_hold_args *args, struct ast_ari_response *response);
221 /*! \brief Argument struct for ast_ari_channels_unhold() */
222 struct ast_ari_channels_unhold_args {
223         /*! \brief Channel's id */
224         const char *channel_id;
225 };
226 /*!
227  * \brief Remove a channel from hold.
228  *
229  * \param headers HTTP headers
230  * \param args Swagger parameters
231  * \param[out] response HTTP response
232  */
233 void ast_ari_channels_unhold(struct ast_variable *headers, struct ast_ari_channels_unhold_args *args, struct ast_ari_response *response);
234 /*! \brief Argument struct for ast_ari_channels_start_moh() */
235 struct ast_ari_channels_start_moh_args {
236         /*! \brief Channel's id */
237         const char *channel_id;
238         /*! \brief Music on hold class to use */
239         const char *moh_class;
240 };
241 /*!
242  * \brief Play music on hold to a channel.
243  *
244  * 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.
245  *
246  * \param headers HTTP headers
247  * \param args Swagger parameters
248  * \param[out] response HTTP response
249  */
250 void ast_ari_channels_start_moh(struct ast_variable *headers, struct ast_ari_channels_start_moh_args *args, struct ast_ari_response *response);
251 /*! \brief Argument struct for ast_ari_channels_stop_moh() */
252 struct ast_ari_channels_stop_moh_args {
253         /*! \brief Channel's id */
254         const char *channel_id;
255 };
256 /*!
257  * \brief Stop playing music on hold to a channel.
258  *
259  * \param headers HTTP headers
260  * \param args Swagger parameters
261  * \param[out] response HTTP response
262  */
263 void ast_ari_channels_stop_moh(struct ast_variable *headers, struct ast_ari_channels_stop_moh_args *args, struct ast_ari_response *response);
264 /*! \brief Argument struct for ast_ari_channels_play() */
265 struct ast_ari_channels_play_args {
266         /*! \brief Channel's id */
267         const char *channel_id;
268         /*! \brief Media's URI to play. */
269         const char *media;
270         /*! \brief For sounds, selects language for sound. */
271         const char *lang;
272         /*! \brief Number of media to skip before playing. */
273         int offsetms;
274         /*! \brief Number of milliseconds to skip for forward/reverse operations. */
275         int skipms;
276 };
277 /*!
278  * \brief Start playback of media.
279  *
280  * 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.)
281  *
282  * \param headers HTTP headers
283  * \param args Swagger parameters
284  * \param[out] response HTTP response
285  */
286 void ast_ari_channels_play(struct ast_variable *headers, struct ast_ari_channels_play_args *args, struct ast_ari_response *response);
287 /*! \brief Argument struct for ast_ari_channels_record() */
288 struct ast_ari_channels_record_args {
289         /*! \brief Channel's id */
290         const char *channel_id;
291         /*! \brief Recording's filename */
292         const char *name;
293         /*! \brief Format to encode audio in */
294         const char *format;
295         /*! \brief Maximum duration of the recording, in seconds. 0 for no limit */
296         int max_duration_seconds;
297         /*! \brief Maximum duration of silence, in seconds. 0 for no limit */
298         int max_silence_seconds;
299         /*! \brief Action to take if a recording with the same name already exists. */
300         const char *if_exists;
301         /*! \brief Play beep when recording begins */
302         int beep;
303         /*! \brief DTMF input to terminate recording */
304         const char *terminate_on;
305 };
306 /*!
307  * \brief Start a recording.
308  *
309  * 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.
310  *
311  * \param headers HTTP headers
312  * \param args Swagger parameters
313  * \param[out] response HTTP response
314  */
315 void ast_ari_channels_record(struct ast_variable *headers, struct ast_ari_channels_record_args *args, struct ast_ari_response *response);
316 /*! \brief Argument struct for ast_ari_channels_get_channel_var() */
317 struct ast_ari_channels_get_channel_var_args {
318         /*! \brief Channel's id */
319         const char *channel_id;
320         /*! \brief The channel variable or function to get */
321         const char *variable;
322 };
323 /*!
324  * \brief Get 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_channels_get_channel_var(struct ast_variable *headers, struct ast_ari_channels_get_channel_var_args *args, struct ast_ari_response *response);
331 /*! \brief Argument struct for ast_ari_channels_set_channel_var() */
332 struct ast_ari_channels_set_channel_var_args {
333         /*! \brief Channel's id */
334         const char *channel_id;
335         /*! \brief The channel variable or function to set */
336         const char *variable;
337         /*! \brief The value to set the variable to */
338         const char *value;
339 };
340 /*!
341  * \brief Set the value of a channel variable or function.
342  *
343  * \param headers HTTP headers
344  * \param args Swagger parameters
345  * \param[out] response HTTP response
346  */
347 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);
348
349 #endif /* _ASTERISK_RESOURCE_CHANNELS_H */