Migrate a large number of AMI events over to Stasis-Core
[asterisk/asterisk.git] / include / asterisk / app.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  * See http://www.asterisk.org for more information about
8  * the Asterisk project. Please do not directly contact
9  * any of the maintainers of this project for assistance;
10  * the project provides a web site, mailing lists and IRC
11  * channels for your use.
12  *
13  * This program is free software, distributed under the terms of
14  * the GNU General Public License Version 2. See the LICENSE file
15  * at the top of the source tree.
16  */
17
18 /*! \file
19  * \brief Application convenience functions, designed to give consistent
20  *        look and feel to Asterisk apps.
21  */
22
23 #ifndef _ASTERISK_APP_H
24 #define _ASTERISK_APP_H
25
26 #include "asterisk/stringfields.h"
27 #include "asterisk/strings.h"
28 #include "asterisk/threadstorage.h"
29 #include "asterisk/file.h"
30 #include "asterisk/linkedlists.h"
31 #include "asterisk/utils.h"
32
33 struct ast_flags64;
34
35 #if defined(__cplusplus) || defined(c_plusplus)
36 extern "C" {
37 #endif
38
39 AST_THREADSTORAGE_EXTERNAL(ast_str_thread_global_buf);
40
41 /* IVR stuff */
42
43 /*! \brief Callback function for IVR
44     \return returns 0 on completion, -1 on hangup or digit if interrupted
45   */
46 typedef int (*ast_ivr_callback)(struct ast_channel *chan, char *option, void *cbdata);
47
48 typedef enum {
49         AST_ACTION_UPONE,       /*!< adata is unused */
50         AST_ACTION_EXIT,        /*!< adata is the return value for ast_ivr_menu_run if channel was not hungup */
51         AST_ACTION_CALLBACK,    /*!< adata is an ast_ivr_callback */
52         AST_ACTION_PLAYBACK,    /*!< adata is file to play */
53         AST_ACTION_BACKGROUND,  /*!< adata is file to play */
54         AST_ACTION_PLAYLIST,    /*!< adata is list of files, separated by ; to play */
55         AST_ACTION_MENU,        /*!< adata is a pointer to an ast_ivr_menu */
56         AST_ACTION_REPEAT,      /*!< adata is max # of repeats, cast to a pointer */
57         AST_ACTION_RESTART,     /*!< adata is like repeat, but resets repeats to 0 */
58         AST_ACTION_TRANSFER,    /*!< adata is a string with exten\verbatim[@context]\endverbatim */
59         AST_ACTION_WAITOPTION,  /*!< adata is a timeout, or 0 for defaults */
60         AST_ACTION_NOOP,        /*!< adata is unused */
61         AST_ACTION_BACKLIST,    /*!< adata is list of files separated by ; allows interruption */
62 } ast_ivr_action;
63
64 /*!
65     Special "options" are:
66    \arg "s" - "start here (one time greeting)"
67    \arg "g" - "greeting/instructions"
68    \arg "t" - "timeout"
69    \arg "h" - "hangup"
70    \arg "i" - "invalid selection"
71
72 */
73 struct ast_ivr_option {
74         char *option;
75         ast_ivr_action action;
76         void *adata;
77 };
78
79 struct ast_ivr_menu {
80         char *title;            /*!< Title of menu */
81         unsigned int flags;     /*!< Flags */
82         struct ast_ivr_option *options; /*!< All options */
83 };
84  
85 /*!
86  * \brief Structure used for ast_copy_recording_to_vm in order to cleanly supply
87  * data needed for making the recording from the recorded file.
88  */
89 struct ast_vm_recording_data {
90         AST_DECLARE_STRING_FIELDS(
91                 AST_STRING_FIELD(context);
92                 AST_STRING_FIELD(mailbox);
93                 AST_STRING_FIELD(folder);
94                 AST_STRING_FIELD(recording_file);
95                 AST_STRING_FIELD(recording_ext);
96
97                 AST_STRING_FIELD(call_context);
98                 AST_STRING_FIELD(call_macrocontext);
99                 AST_STRING_FIELD(call_extension);
100                 AST_STRING_FIELD(call_callerchan);
101                 AST_STRING_FIELD(call_callerid);
102                 );
103         int call_priority;
104 };
105
106 #define AST_IVR_FLAG_AUTORESTART (1 << 0)
107
108 #define AST_IVR_DECLARE_MENU(holder, title, flags, foo...) \
109         static struct ast_ivr_option __options_##holder[] = foo;\
110         static struct ast_ivr_menu holder = { title, flags, __options_##holder }
111
112 enum ast_timelen {
113         TIMELEN_HOURS,
114         TIMELEN_MINUTES,
115         TIMELEN_SECONDS,
116         TIMELEN_MILLISECONDS,
117 };
118
119 /*!     \brief Runs an IVR menu
120         \return returns 0 on successful completion, -1 on hangup, or -2 on user error in menu */
121 int ast_ivr_menu_run(struct ast_channel *c, struct ast_ivr_menu *menu, void *cbdata);
122
123 /*! \brief Plays a stream and gets DTMF data from a channel
124  * \param c Which channel one is interacting with
125  * \param prompt File to pass to ast_streamfile (the one that you wish to play).
126  *        It is also valid for this to be multiple files concatenated by "&".
127  *        For example, "file1&file2&file3".
128  * \param s The location where the DTMF data will be stored
129  * \param maxlen Max Length of the data
130  * \param timeout Timeout length waiting for data(in milliseconds).  Set to 0 for standard timeout(six seconds), or -1 for no time out.
131  *
132  *  This function was designed for application programmers for situations where they need
133  *  to play a message and then get some DTMF data in response to the message.  If a digit
134  *  is pressed during playback, it will immediately break out of the message and continue
135  *  execution of your code.
136  */
137 int ast_app_getdata(struct ast_channel *c, const char *prompt, char *s, int maxlen, int timeout);
138
139 /*! \brief Full version with audiofd and controlfd.  NOTE: returns '2' on ctrlfd available, not '1' like other full functions */
140 int ast_app_getdata_full(struct ast_channel *c, const char *prompt, char *s, int maxlen, int timeout, int audiofd, int ctrlfd);
141
142 /*!
143  * \brief Run a macro on a channel, placing an optional second channel into autoservice.
144  * \since 11.0
145  *
146  * \details
147  * This is a shorthand method that makes it very easy to run a
148  * macro on any given channel.  It is perfectly reasonable to
149  * supply a NULL autoservice_chan here in case there is no
150  * channel to place into autoservice.
151  *
152  * \note Absolutely _NO_ channel locks should be held before calling this function.
153  *
154  * \param autoservice_chan A channel to place into autoservice while the macro is run
155  * \param macro_chan Channel to execute macro on.
156  * \param macro_args Macro application argument string.
157  *
158  * \retval 0 success
159  * \retval -1 on error
160  */
161 int ast_app_exec_macro(struct ast_channel *autoservice_chan, struct ast_channel *macro_chan, const char *macro_args);
162
163 /*!
164  * \since 1.8
165  * \brief Run a macro on a channel, placing an optional second channel into autoservice.
166  *
167  * \details
168  * This is a shorthand method that makes it very easy to run a
169  * macro on any given channel.  It is perfectly reasonable to
170  * supply a NULL autoservice_chan here in case there is no
171  * channel to place into autoservice.
172  *
173  * \note Absolutely _NO_ channel locks should be held before calling this function.
174  *
175  * \param autoservice_chan A channel to place into autoservice while the macro is run
176  * \param macro_chan Channel to execute macro on.
177  * \param macro_name The name of the macro to run.
178  * \param macro_args The arguments to pass to the macro.
179  *
180  * \retval 0 success
181  * \retval -1 on error
182  */
183 int ast_app_run_macro(struct ast_channel *autoservice_chan,
184         struct ast_channel *macro_chan, const char *macro_name, const char *macro_args);
185
186 /*!
187  * \brief Stack applications callback functions.
188  */
189 struct ast_app_stack_funcs {
190         /*!
191          * Module reference pointer so the module will stick around
192          * while a callback is active.
193          */
194         void *module;
195
196         /*!
197          * \brief Callback for the routine to run a subroutine on a channel.
198          *
199          * \note Absolutely _NO_ channel locks should be held before calling this function.
200          *
201          * \param chan Channel to execute subroutine on.
202          * \param args Gosub application argument string.
203          * \param ignore_hangup TRUE if a hangup does not stop execution of the routine.
204          *
205          * \retval 0 success
206          * \retval -1 on error
207          */
208         int (*run_sub)(struct ast_channel *chan, const char *args, int ignore_hangup);
209
210         /*!
211          * \brief Add missing context/exten to Gosub application argument string.
212          *
213          * \param chan Channel to obtain context/exten.
214          * \param args Gosub application argument string.
215          *
216          * \details
217          * Fills in the optional context and exten from the given channel.
218          *
219          * \retval New-args Gosub argument string on success.  Must be freed.
220          * \retval NULL on error.
221          */
222         const char *(*expand_sub_args)(struct ast_channel *chan, const char *args);
223
224         /* Add new API calls to the end here. */
225 };
226
227 /*!
228  * \since 11
229  * \brief Set stack application function callbacks
230  * \param funcs Stack applications callback functions.
231  */
232 void ast_install_stack_functions(const struct ast_app_stack_funcs *funcs);
233
234 /*!
235  * \brief Add missing context/exten to subroutine argument string.
236  *
237  * \param chan Channel to obtain context/exten.
238  * \param args Gosub application argument string.
239  *
240  * \details
241  * Fills in the optional context and exten from the given channel.
242  *
243  * \retval New-args Gosub argument string on success.  Must be freed.
244  * \retval NULL on error.
245  */
246 const char *ast_app_expand_sub_args(struct ast_channel *chan, const char *args);
247
248 /*!
249  * \since 11
250  * \brief Run a subroutine on a channel, placing an optional second channel into autoservice.
251  *
252  * \details
253  * This is a shorthand method that makes it very easy to run a
254  * subroutine on any given channel.  It is perfectly reasonable
255  * to supply a NULL autoservice_chan here in case there is no
256  * channel to place into autoservice.
257  *
258  * \note Absolutely _NO_ channel locks should be held before calling this function.
259  *
260  * \param autoservice_chan A channel to place into autoservice while the subroutine is run
261  * \param sub_chan Channel to execute subroutine on.
262  * \param sub_args Gosub application argument string.
263  * \param ignore_hangup TRUE if a hangup does not stop execution of the routine.
264  *
265  * \retval 0 success
266  * \retval -1 on error
267  */
268 int ast_app_exec_sub(struct ast_channel *autoservice_chan, struct ast_channel *sub_chan, const char *sub_args, int ignore_hangup);
269
270 /*!
271  * \since 11
272  * \brief Run a subroutine on a channel, placing an optional second channel into autoservice.
273  *
274  * \details
275  * This is a shorthand method that makes it very easy to run a
276  * subroutine on any given channel.  It is perfectly reasonable
277  * to supply a NULL autoservice_chan here in case there is no
278  * channel to place into autoservice.
279  *
280  * \note Absolutely _NO_ channel locks should be held before calling this function.
281  *
282  * \param autoservice_chan A channel to place into autoservice while the subroutine is run
283  * \param sub_chan Channel to execute subroutine on.
284  * \param sub_location The location of the subroutine to run.
285  * \param sub_args The arguments to pass to the subroutine.
286  * \param ignore_hangup TRUE if a hangup does not stop execution of the routine.
287  *
288  * \retval 0 success
289  * \retval -1 on error
290  */
291 int ast_app_run_sub(struct ast_channel *autoservice_chan,
292         struct ast_channel *sub_chan, const char *sub_location, const char *sub_args, int ignore_hangup);
293
294 enum ast_vm_snapshot_sort_val {
295         AST_VM_SNAPSHOT_SORT_BY_ID = 0,
296         AST_VM_SNAPSHOT_SORT_BY_TIME,
297 };
298
299 struct ast_vm_msg_snapshot {
300         AST_DECLARE_STRING_FIELDS(
301                 AST_STRING_FIELD(msg_id);
302                 AST_STRING_FIELD(callerid);
303                 AST_STRING_FIELD(callerchan);
304                 AST_STRING_FIELD(exten);
305                 AST_STRING_FIELD(origdate);
306                 AST_STRING_FIELD(origtime);
307                 AST_STRING_FIELD(duration);
308                 AST_STRING_FIELD(folder_name);
309                 AST_STRING_FIELD(flag);
310         );
311         unsigned int msg_number;
312
313         AST_LIST_ENTRY(ast_vm_msg_snapshot) msg;
314 };
315
316 struct ast_vm_mailbox_snapshot {
317         int total_msg_num;
318         int folders;
319         /* Things are not quite as they seem here.  This points to an allocated array of lists. */
320         AST_LIST_HEAD_NOLOCK(, ast_vm_msg_snapshot) *snapshots;
321 };
322
323 /*!
324  * \brief Voicemail playback callback function definition
325  *
326  * \param channel to play the file back on.
327  * \param location of file on disk
328  * \param duration of file in seconds. This will be zero if msg is very short or
329  * has an unknown duration.
330  */
331 typedef void (ast_vm_msg_play_cb)(struct ast_channel *chan, const char *playfile, int duration);
332
333 /*!
334  * \brief Set voicemail function callbacks
335  *
336  * \param copy_recording_to_vm_func, vm_index_to_foldername, vm_mailbox_snapshot_create
337  * \param vm_mailbox_snapshot_destroy, vm_msg_move, vm_msg_remove, vm_msg_forward, vm_msg_play
338  * \param[in] has_voicemail_func set function pointer
339  * \param[in] inboxcount_func set function pointer
340  * \param[in] inboxcount2_func set function pointer
341  * \param[in] messagecount_func set function pointer
342  * \param[in] sayname_func set function pointer
343  * \version 1.6.1 Added inboxcount2_func, sayname_func
344  */
345 void ast_install_vm_functions(int (*has_voicemail_func)(const char *mailbox, const char *folder),
346                               int (*inboxcount_func)(const char *mailbox, int *newmsgs, int *oldmsgs),
347                               int (*inboxcount2_func)(const char *mailbox, int *urgentmsgs, int *newmsgs, int *oldmsgs),
348                               int (*messagecount_func)(const char *context, const char *mailbox, const char *folder),
349                               int (*sayname_func)(struct ast_channel *chan, const char *mailbox, const char *context),
350                               int (*copy_recording_to_vm_func)(struct ast_vm_recording_data *vm_rec_data),
351                               const char *vm_index_to_foldername(int id),
352                               struct ast_vm_mailbox_snapshot *(*vm_mailbox_snapshot_create)(const char *mailbox,
353                                 const char *context,
354                                 const char *folder,
355                                 int descending,
356                                 enum ast_vm_snapshot_sort_val sort_val,
357                                 int combine_INBOX_and_OLD),
358                               struct ast_vm_mailbox_snapshot *(*vm_mailbox_snapshot_destroy)(struct ast_vm_mailbox_snapshot *mailbox_snapshot),
359                               int (*vm_msg_move)(const char *mailbox,
360                                 const char *context,
361                                 size_t num_msgs,
362                                 const char *oldfolder,
363                                 const char *old_msg_ids[],
364                                 const char *newfolder),
365                               int (*vm_msg_remove)(const char *mailbox,
366                                 const char *context,
367                                 size_t num_msgs,
368                                 const char *folder,
369                                 const char *msgs[]),
370                               int (*vm_msg_forward)(const char *from_mailbox,
371                                 const char *from_context,
372                                 const char *from_folder,
373                                 const char *to_mailbox,
374                                 const char *to_context,
375                                 const char *to_folder,
376                                 size_t num_msgs,
377                                 const char *msg_ids[],
378                                 int delete_old),
379                               int (*vm_msg_play)(struct ast_channel *chan,
380                                 const char *mailbox,
381                                 const char *context,
382                                 const char *folder,
383                                 const char *msg_num,
384                                 ast_vm_msg_play_cb cb));
385
386
387 void ast_uninstall_vm_functions(void);
388
389 #ifdef TEST_FRAMEWORK
390 void ast_install_vm_test_functions(int (*vm_test_destroy_user)(const char *context, const char *mailbox),
391                                    int (*vm_test_create_user)(const char *context, const char *mailbox));
392
393 void ast_uninstall_vm_test_functions(void);
394 #endif
395
396 /*!
397  * \brief
398  * param[in] vm_rec_data Contains data needed to make the recording.
399  * retval 0 voicemail successfully created from recording.
400  * retval -1 Failure
401  */
402 int ast_app_copy_recording_to_vm(struct ast_vm_recording_data *vm_rec_data);
403
404 /*!
405  * \brief Determine if a given mailbox has any voicemail
406  * If folder is NULL, defaults to "INBOX".  If folder is "INBOX", includes the
407  * number of messages in the "Urgent" folder.
408  * \retval 1 Mailbox has voicemail
409  * \retval 0 No new voicemail in specified mailbox
410  * \retval -1 Failure
411  * \since 1.0
412  */
413 int ast_app_has_voicemail(const char *mailbox, const char *folder);
414
415 /*!
416  * \brief Determine number of new/old messages in a mailbox
417  * \since 1.0
418  * \param[in] mailbox Mailbox specification in the format
419  *      /code
420  *       mbox[\@context][&mbox2[\@context2]][...]
421  *      /code
422  * \param[out] newmsgs Number of messages in the "INBOX" folder.  Includes number of messages in the "Urgent" folder, if any.
423  * \param[out] oldmsgs Number of messages in the "Old" folder.
424  * \retval 0 Success
425  * \retval -1 Failure
426  */
427 int ast_app_inboxcount(const char *mailbox, int *newmsgs, int *oldmsgs);
428
429 /*!
430  * \brief Determine number of urgent/new/old messages in a mailbox
431  * \param[in] mailbox the mailbox context to use
432  * \param[out] urgentmsgs the urgent message count
433  * \param[out] newmsgs the new message count
434  * \param[out] oldmsgs the old message count
435  * \return Returns 0 for success, negative upon error
436  * \since 1.6.1
437  */
438 int ast_app_inboxcount2(const char *mailbox, int *urgentmsgs, int *newmsgs, int *oldmsgs);
439
440 /*!
441  * \brief Given a mailbox and context, play that mailbox owner's name to the channel specified
442  * \param[in] chan Channel on which to play the name
443  * \param[in] mailbox Mailbox number from which to retrieve the recording
444  * \param[in] context Mailbox context from which to locate the mailbox number
445  * \retval 0 Name played without interruption
446  * \retval dtmf ASCII value of the DTMF which interrupted playback.
447  * \retval -1 Unable to locate mailbox or hangup occurred.
448  * \since 1.6.1
449  */
450 int ast_app_sayname(struct ast_channel *chan, const char *mailbox, const char *context);
451
452 /*!
453  * \brief Check number of messages in a given context, mailbox, and folder
454  * \since 1.4
455  * \param[in] context Mailbox context
456  * \param[in] mailbox Mailbox number
457  * \param[in] folder Mailbox folder
458  * \return Number of messages in the given context, mailbox, and folder.  If folder is NULL, folder "INBOX" is assumed.  If folder is "INBOX", includes number of messages in the "Urgent" folder.
459  */
460 int ast_app_messagecount(const char *context, const char *mailbox, const char *folder);
461
462 /*!
463  * \brief Return name of folder, given an id
464  * \param[in] id Folder id
465  * \return Name of folder
466  */
467 const char *ast_vm_index_to_foldername(int id);
468
469 /*
470  * \brief Create a snapshot of a mailbox which contains information about every msg.
471  *
472  * \param mailbox, the mailbox to look for
473  * \param context, the context to look for the mailbox in
474  * \param folder, OPTIONAL.  When not NULL only msgs from the specified folder will be included.
475  * \param desending, list the msgs in descending order rather than ascending order.
476  * \param combine_INBOX_and_OLD, When this argument is set, The OLD folder will be represented
477  *        in the INBOX folder of the snapshot. This allows the snapshot to represent the
478  *        OLD and INBOX messages in sorted order merged together.
479  *
480  * \retval snapshot on success
481  * \retval NULL on failure
482  */
483 struct ast_vm_mailbox_snapshot *ast_vm_mailbox_snapshot_create(const char *mailbox,
484         const char *context,
485         const char *folder,
486         int descending,
487         enum ast_vm_snapshot_sort_val sort_val,
488         int combine_INBOX_and_OLD);
489
490 /*
491  * \brief destroy a snapshot
492  *
493  * \param mailbox_snapshot The snapshot to destroy.
494  * \retval NULL
495  */
496 struct ast_vm_mailbox_snapshot *ast_vm_mailbox_snapshot_destroy(struct ast_vm_mailbox_snapshot *mailbox_snapshot);
497
498 /*!
499  * \brief Move messages from one folder to another
500  *
501  * \param mailbox The mailbox to which the folders belong
502  * \param context The voicemail context for the mailbox
503  * \param num_msgs The number of messages to move
504  * \param oldfolder The folder from where messages should be moved
505  * \param old_msg_ids The message IDs of the messages to move
506  * \param newfolder The folder to which messages should be moved
507  * new folder. This array must be num_msgs sized.
508  *
509  * \retval -1 Failure
510  * \retval 0 Success
511  */
512 int ast_vm_msg_move(const char *mailbox,
513         const char *context,
514         size_t num_msgs,
515         const char *oldfolder,
516         const char *old_msg_ids[],
517         const char *newfolder);
518
519 /*!
520  * \brief Remove/delete messages from a mailbox folder.
521  *
522  * \param mailbox The mailbox from which to delete messages
523  * \param context The voicemail context for the mailbox
524  * \param num_msgs The number of messages to delete
525  * \param folder The folder from which to remove messages
526  * \param msgs The message IDs of the messages to delete
527  *
528  * \retval -1 Failure
529  * \retval 0 Success
530  */
531 int ast_vm_msg_remove(const char *mailbox,
532         const char *context,
533         size_t num_msgs,
534         const char *folder,
535         const char *msgs[]);
536
537 /*!
538  * \brief forward a message from one mailbox to another.
539  *
540  * \brief from_mailbox The original mailbox the message is being forwarded from
541  * \brief from_context The voicemail context of the from_mailbox
542  * \brief from_folder The folder from which the message is being forwarded
543  * \brief to_mailbox The mailbox to forward the message to
544  * \brief to_context The voicemail context of the to_mailbox
545  * \brief to_folder The folder to which the message is being forwarded
546  * \brief num_msgs The number of messages being forwarded
547  * \brief msg_ids The message IDs of the messages in from_mailbox to forward
548  * \brief delete_old If non-zero, the forwarded messages are also deleted from from_mailbox.
549  * Otherwise, the messages will remain in the from_mailbox.
550  *
551  * \retval -1 Failure
552  * \retval 0 Success
553  */
554 int ast_vm_msg_forward(const char *from_mailbox,
555         const char *from_context,
556         const char *from_folder,
557         const char *to_mailbox,
558         const char *to_context,
559         const char *to_folder,
560         size_t num_msgs,
561         const char *msg_ids[],
562         int delete_old);
563
564 /*!
565  * \brief Play a voicemail msg back on a channel.
566  *
567  * \param chan
568  * \param mailbox msg is in.
569  * \param context of mailbox.
570  * \param folder voicemail folder to look in.
571  * \param msg_num message number in the voicemailbox to playback to the channel.
572  * \param cb
573  *
574  * \retval 0 success
575  * \retval -1 failure
576  */
577 int ast_vm_msg_play(struct ast_channel *chan,
578         const char *mailbox,
579         const char *context,
580         const char *folder,
581         const char *msg_num,
582         ast_vm_msg_play_cb cb);
583
584 #ifdef TEST_FRAMEWORK
585 int ast_vm_test_destroy_user(const char *context, const char *mailbox);
586 int ast_vm_test_create_user(const char *context, const char *mailbox);
587 #endif
588
589 /*! \brief Safely spawn an external program while closing file descriptors
590         \note This replaces the \b system call in all Asterisk modules
591 */
592 int ast_safe_system(const char *s);
593
594 /*!
595  * \brief Replace the SIGCHLD handler
596  *
597  * Normally, Asterisk has a SIGCHLD handler that is cleaning up all zombie
598  * processes from forking elsewhere in Asterisk.  However, if you want to
599  * wait*() on the process to retrieve information about it's exit status,
600  * then this signal handler needs to be temporarily replaced.
601  *
602  * Code that executes this function *must* call ast_unreplace_sigchld()
603  * after it is finished doing the wait*().
604  */
605 void ast_replace_sigchld(void);
606
607 /*!
608  * \brief Restore the SIGCHLD handler
609  *
610  * This function is called after a call to ast_replace_sigchld.  It restores
611  * the SIGCHLD handler that cleans up any zombie processes.
612  */
613 void ast_unreplace_sigchld(void);
614
615 /*!
616   \brief Send DTMF to a channel
617
618   \param chan    The channel that will receive the DTMF frames
619   \param peer    (optional) Peer channel that will be autoserviced while the
620                  primary channel is receiving DTMF
621   \param digits  This is a string of characters representing the DTMF digits
622                  to be sent to the channel.  Valid characters are
623                  "0123456789*#abcdABCD".  Note: You can pass arguments 'f' or
624                  'F', if you want to Flash the channel (if supported by the
625                  channel), or 'w' to add a 500 millisecond pause to the DTMF
626                  sequence.
627   \param between This is the number of milliseconds to wait in between each
628                  DTMF digit.  If zero milliseconds is specified, then the
629                  default value of 100 will be used.
630   \param duration This is the duration that each DTMF digit should have.
631 */
632 int ast_dtmf_stream(struct ast_channel *chan, struct ast_channel *peer, const char *digits, int between, unsigned int duration);
633
634 /*! \brief Stream a filename (or file descriptor) as a generator. */
635 int ast_linear_stream(struct ast_channel *chan, const char *filename, int fd, int allowoverride);
636
637 /*!
638  * \brief Stream a file with fast forward, pause, reverse, restart.
639  * \param chan Channel
640  * \param file File to play.
641  * \param fwd, rev, stop, pause, restart DTMF keys for media control
642  * \param skipms Number of milliseconds to skip for fwd/rev.
643  * \param offsetms Number of milliseconds to skip when starting the media.
644  *
645  * Before calling this function, set this to be the number
646  * of ms to start from the beginning of the file.  When the function
647  * returns, it will be the number of ms from the beginning where the
648  * playback stopped.  Pass NULL if you don't care.
649  *
650  * \retval 0 on success
651  * \retval Non-zero on failure
652  */
653 int ast_control_streamfile(struct ast_channel *chan, const char *file, const char *fwd, const char *rev, const char *stop, const char *pause, const char *restart, int skipms, long *offsetms);
654
655 /*!
656  * \brief Version of ast_control_streamfile() which allows the language of the
657  * media file to be specified.
658  *
659  * \retval 0 on success
660  * \retval Non-zero on failure
661  */
662 int ast_control_streamfile_lang(struct ast_channel *chan, const char *file,
663         const char *fwd, const char *rev, const char *stop, const char *suspend,
664         const char *restart, int skipms, const char *lang, long *offsetms);
665
666 /*!
667  * \brief Stream a file with fast forward, pause, reverse, restart.
668  * \param chan
669  * \param file filename
670  * \param fwd, rev, stop, pause, restart, skipms, offsetms
671  * \param cb waitstream callback to invoke when fastforward or rewind occurrs.
672  *
673  * Before calling this function, set this to be the number
674  * of ms to start from the beginning of the file.  When the function
675  * returns, it will be the number of ms from the beginning where the
676  * playback stopped.  Pass NULL if you don't care.
677  */
678 int ast_control_streamfile_w_cb(struct ast_channel *chan,
679         const char *file,
680         const char *fwd,
681         const char *rev,
682         const char *stop,
683         const char *pause,
684         const char *restart,
685         int skipms,
686         long *offsetms,
687         ast_waitstream_fr_cb cb);
688
689 /*! \brief Play a stream and wait for a digit, returning the digit that was pressed */
690 int ast_play_and_wait(struct ast_channel *chan, const char *fn);
691
692 /*!
693  * \brief Record a file based on input from a channel
694  *        This function will play "auth-thankyou" upon successful recording.
695  *
696  * \param chan the channel being recorded
697  * \param playfile Filename of sound to play before recording begins
698  * \param recordfile Filename to save the recording
699  * \param maxtime_sec Longest possible message length in seconds
700  * \param fmt string containing all formats to be recorded delimited by '|'
701  * \param duration pointer to integer for storing length of the recording
702  * \param sound_duration pointer to integer for storing length of the recording minus all silence
703  * \param silencethreshold tolerance of noise levels that can be considered silence for the purpose of silence timeout, -1 for default
704  * \param maxsilence_ms Length of time in milliseconds which will trigger a timeout from silence, -1 for default
705  * \param path Optional filesystem path to unlock
706  * \param acceptdtmf Character of DTMF to end and accept the recording
707  * \param canceldtmf Character of DTMF to end and cancel the recording
708  *
709  * \retval -1 failure or hangup
710  * \retval 'S' Recording ended from silence timeout
711  * \retval 't' Recording ended from the message exceeding the maximum duration
712  * \retval dtmfchar Recording ended via the return value's DTMF character for either cancel or accept.
713  */
714 int ast_play_and_record_full(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime_sec, const char *fmt, int *duration, int *sound_duration, int silencethreshold, int maxsilence_ms, const char *path, const char *acceptdtmf, const char *canceldtmf);
715
716 /*!
717  * \brief Record a file based on input from a channel. Use default accept and cancel DTMF.
718  *        This function will play "auth-thankyou" upon successful recording.
719  *
720  * \param chan the channel being recorded
721  * \param playfile Filename of sound to play before recording begins
722  * \param recordfile Filename to save the recording
723  * \param maxtime_sec Longest possible message length in seconds
724  * \param fmt string containing all formats to be recorded delimited by '|'
725  * \param duration pointer to integer for storing length of the recording
726  * \param sound_duration pointer to integer for storing length of the recording minus all silence
727  * \param silencethreshold tolerance of noise levels that can be considered silence for the purpose of silence timeout, -1 for default
728  * \param maxsilence_ms length of time in milliseconds which will trigger a timeout from silence, -1 for default
729  * \param path Optional filesystem path to unlock
730  *
731  * \retval -1 failure or hangup
732  * \retval 'S' Recording ended from silence timeout
733  * \retval 't' Recording ended from the message exceeding the maximum duration
734  * \retval dtmfchar Recording ended via the return value's DTMF character for either cancel or accept.
735  */
736 int ast_play_and_record(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime_sec, const char *fmt, int *duration, int *sound_duration, int silencethreshold, int maxsilence_ms, const char *path);
737
738 /*!
739  * \brief Record a file based on input frm a channel. Recording is performed in 'prepend' mode which works a little differently from normal recordings
740  *        This function will not play a success message due to post-recording control in the application this was added for.
741  *
742  * \param chan the channel being recorded
743  * \param playfile Filename of sound to play before recording begins
744  * \param recordfile Filename to save the recording
745  * \param maxtime_sec Longest possible message length in seconds
746  * \param fmt string containing all formats to be recorded delimited by '|'
747  * \param duration pointer to integer for storing length of the recording
748  * \param sound_duration pointer to integer for storing length of the recording minus all silence
749  * \param beep whether to play a beep to prompt the recording
750  * \param silencethreshold tolerance of noise levels that can be considered silence for the purpose of silence timeout, -1 for default
751  * \param maxsilence_ms length of time in milliseconds which will trigger a timeout from silence, -1 for default.
752  *
753  * \retval -1 failure or hangup
754  * \retval 'S' Recording ended from silence timeout
755  * \retval 't' Recording either exceeded maximum duration or the call was ended via DTMF
756  */
757 int ast_play_and_prepend(struct ast_channel *chan, char *playfile, char *recordfile, int maxtime_sec, char *fmt, int *duration, int *sound_duration, int beep, int silencethreshold, int maxsilence_ms);
758
759 enum ast_getdata_result {
760         AST_GETDATA_FAILED = -1,
761         AST_GETDATA_COMPLETE = 0,
762         AST_GETDATA_TIMEOUT = 1,
763         AST_GETDATA_INTERRUPTED = 2,
764         /*! indicates a user terminated empty string rather than an empty string resulting 
765          * from a timeout or other factors */
766         AST_GETDATA_EMPTY_END_TERMINATED = 3,
767 };
768
769 enum AST_LOCK_RESULT {
770         AST_LOCK_SUCCESS = 0,
771         AST_LOCK_TIMEOUT = -1,
772         AST_LOCK_PATH_NOT_FOUND = -2,
773         AST_LOCK_FAILURE = -3,
774 };
775
776 /*! \brief Type of locking to use in ast_lock_path / ast_unlock_path */
777 enum AST_LOCK_TYPE {
778         AST_LOCK_TYPE_LOCKFILE = 0,
779         AST_LOCK_TYPE_FLOCK = 1,
780 };
781
782 /*!
783  * \brief Set the type of locks used by ast_lock_path()
784  * \param type the locking type to use
785  */
786 void ast_set_lock_type(enum AST_LOCK_TYPE type);
787
788 /*!
789  * \brief Lock a filesystem path.
790  * \param path the path to be locked
791  * \return one of \ref AST_LOCK_RESULT values
792  */
793 enum AST_LOCK_RESULT ast_lock_path(const char *path);
794
795 /*! \brief Unlock a path */
796 int ast_unlock_path(const char *path);
797
798 /*! \brief Read a file into asterisk*/
799 char *ast_read_textfile(const char *file);
800
801 struct ast_group_info;
802
803 /*! \brief Split a group string into group and category, returning a default category if none is provided. */
804 int ast_app_group_split_group(const char *data, char *group, int group_max, char *category, int category_max);
805
806 /*! \brief Set the group for a channel, splitting the provided data into group and category, if specified. */
807 int ast_app_group_set_channel(struct ast_channel *chan, const char *data);
808
809 /*! \brief Get the current channel count of the specified group and category. */
810 int ast_app_group_get_count(const char *group, const char *category);
811
812 /*! \brief Get the current channel count of all groups that match the specified pattern and category. */
813 int ast_app_group_match_get_count(const char *groupmatch, const char *category);
814
815 /*! \brief Discard all group counting for a channel */
816 int ast_app_group_discard(struct ast_channel *chan);
817
818 /*! \brief Update all group counting for a channel to a new one */
819 int ast_app_group_update(struct ast_channel *oldchan, struct ast_channel *newchan);
820
821 /*! \brief Write Lock the group count list */
822 int ast_app_group_list_wrlock(void);
823
824 /*! \brief Read Lock the group count list */
825 int ast_app_group_list_rdlock(void);
826
827 /*! \brief Get the head of the group count list */
828 struct ast_group_info *ast_app_group_list_head(void);
829
830 /*! \brief Unlock the group count list */
831 int ast_app_group_list_unlock(void);
832
833 /*!
834   \brief Define an application argument
835   \param name The name of the argument
836 */
837 #define AST_APP_ARG(name) char *name
838
839 /*!
840   \brief Declare a structure to hold an application's arguments.
841   \param name The name of the structure
842   \param arglist The list of arguments, defined using AST_APP_ARG
843
844   This macro declares a structure intended to be used in a call
845   to ast_app_separate_args(). The structure includes all the
846   arguments specified, plus an argv array that overlays them and an
847   argc argument counter. The arguments must be declared using AST_APP_ARG,
848   and they will all be character pointers (strings).
849
850   \note The structure is <b>not</b> initialized, as the call to
851   ast_app_separate_args() will perform that function before parsing
852   the arguments.
853  */
854 #define AST_DECLARE_APP_ARGS(name, arglist) AST_DEFINE_APP_ARGS_TYPE(, arglist) name = { 0, }
855
856 /*!
857   \brief Define a structure type to hold an application's arguments.
858   \param type The name of the structure type
859   \param arglist The list of arguments, defined using AST_APP_ARG
860
861   This macro defines a structure type intended to be used in a call
862   to ast_app_separate_args(). The structure includes all the
863   arguments specified, plus an argv array that overlays them and an
864   argc argument counter. The arguments must be declared using AST_APP_ARG,
865   and they will all be character pointers (strings).
866
867   \note This defines a structure type, but does not declare an instance
868   of the structure. That must be done separately.
869  */
870 #define AST_DEFINE_APP_ARGS_TYPE(type, arglist) \
871         struct type { \
872                 unsigned int argc; \
873                 char *argv[0]; \
874                 arglist \
875         }
876
877 /*!
878   \brief Performs the 'standard' argument separation process for an application.
879   \param args An argument structure defined using AST_DECLARE_APP_ARGS
880   \param parse A modifiable buffer containing the input to be parsed
881
882   This function will separate the input string using the standard argument
883   separator character ',' and fill in the provided structure, including
884   the argc argument counter field.
885  */
886 #define AST_STANDARD_APP_ARGS(args, parse) \
887         args.argc = __ast_app_separate_args(parse, ',', 1, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
888 #define AST_STANDARD_RAW_ARGS(args, parse) \
889         args.argc = __ast_app_separate_args(parse, ',', 0, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
890
891 /*!
892   \brief Performs the 'nonstandard' argument separation process for an application.
893   \param args An argument structure defined using AST_DECLARE_APP_ARGS
894   \param parse A modifiable buffer containing the input to be parsed
895   \param sep A nonstandard separator character
896
897   This function will separate the input string using the nonstandard argument
898   separator character and fill in the provided structure, including
899   the argc argument counter field.
900  */
901 #define AST_NONSTANDARD_APP_ARGS(args, parse, sep) \
902         args.argc = __ast_app_separate_args(parse, sep, 1, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
903 #define AST_NONSTANDARD_RAW_ARGS(args, parse, sep) \
904         args.argc = __ast_app_separate_args(parse, sep, 0, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
905
906 /*!
907   \brief Separate a string into arguments in an array
908   \param buf The string to be parsed (this must be a writable copy, as it will be modified)
909   \param delim The character to be used to delimit arguments
910   \param remove_chars Remove backslashes and quote characters, while parsing
911   \param array An array of 'char *' to be filled in with pointers to the found arguments
912   \param arraylen The number of elements in the array (i.e. the number of arguments you will accept)
913
914   Note: if there are more arguments in the string than the array will hold, the last element of
915   the array will contain the remaining arguments, not separated.
916
917   The array will be completely zeroed by this function before it populates any entries.
918
919   \return The number of arguments found, or zero if the function arguments are not valid.
920 */
921 unsigned int __ast_app_separate_args(char *buf, char delim, int remove_chars, char **array, int arraylen);
922 #define ast_app_separate_args(a,b,c,d)  __ast_app_separate_args(a,b,1,c,d)
923
924 /*!
925   \brief A structure to hold the description of an application 'option'.
926
927   Application 'options' are single-character flags that can be supplied
928   to the application to affect its behavior; they can also optionally
929   accept arguments enclosed in parenthesis.
930
931   These structures are used by the ast_app_parse_options function, uses
932   this data to fill in a flags structure (to indicate which options were
933   supplied) and array of argument pointers (for those options that had
934   arguments supplied).
935  */
936 struct ast_app_option {
937         /*! \brief The flag bit that represents this option. */
938         uint64_t flag;
939         /*! \brief The index of the entry in the arguments array
940           that should be used for this option's argument. */
941         unsigned int arg_index;
942 };
943
944 #define BEGIN_OPTIONS {
945 #define END_OPTIONS }
946
947 /*!
948   \brief Declares an array of options for an application.
949   \param holder The name of the array to be created
950   \param options The actual options to be placed into the array
951   \sa ast_app_parse_options
952
953   This macro declares a 'static const' array of \c struct \c ast_option
954   elements to hold the list of available options for an application.
955   Each option must be declared using either the AST_APP_OPTION()
956   or AST_APP_OPTION_ARG() macros.
957
958   Example usage:
959   \code
960   enum my_app_option_flags {
961         OPT_JUMP = (1 << 0),
962         OPT_BLAH = (1 << 1),
963         OPT_BLORT = (1 << 2),
964   };
965
966   enum my_app_option_args {
967         OPT_ARG_BLAH = 0,
968         OPT_ARG_BLORT,
969         !! this entry tells how many possible arguments there are,
970            and must be the last entry in the list
971         OPT_ARG_ARRAY_SIZE,
972   };
973
974   AST_APP_OPTIONS(my_app_options, {
975         AST_APP_OPTION('j', OPT_JUMP),
976         AST_APP_OPTION_ARG('b', OPT_BLAH, OPT_ARG_BLAH),
977         AST_APP_OPTION_BLORT('B', OPT_BLORT, OPT_ARG_BLORT),
978   });
979
980   static int my_app_exec(struct ast_channel *chan, void *data)
981   {
982         char *options;
983         struct ast_flags opts = { 0, };
984         char *opt_args[OPT_ARG_ARRAY_SIZE];
985
986         ... do any argument parsing here ...
987
988         if (ast_app_parse_options(my_app_options, &opts, opt_args, options)) {
989                 return -1;
990         }
991   }
992   \endcode
993  */
994 #define AST_APP_OPTIONS(holder, options...) \
995         static const struct ast_app_option holder[128] = options
996
997 /*!
998   \brief Declares an application option that does not accept an argument.
999   \param option The single character representing the option
1000   \param flagno The flag index to be set if this option is present
1001   \sa AST_APP_OPTIONS, ast_app_parse_options
1002  */
1003 #define AST_APP_OPTION(option, flagno) \
1004         [option] = { .flag = flagno }
1005
1006 /*!
1007   \brief Declares an application option that accepts an argument.
1008   \param option The single character representing the option
1009   \param flagno The flag index to be set if this option is present
1010   \param argno The index into the argument array where the argument should
1011   be placed
1012   \sa AST_APP_OPTIONS, ast_app_parse_options
1013  */
1014 #define AST_APP_OPTION_ARG(option, flagno, argno) \
1015         [option] = { .flag = flagno, .arg_index = argno + 1 }
1016
1017 /*!
1018   \brief Parses a string containing application options and sets flags/arguments.
1019   \param options The array of possible options declared with AST_APP_OPTIONS
1020   \param flags The flag structure to have option flags set
1021   \param args The array of argument pointers to hold arguments found
1022   \param optstr The string containing the options to be parsed
1023   \return zero for success, non-zero if an error occurs
1024   \sa AST_APP_OPTIONS
1025  */
1026 int ast_app_parse_options(const struct ast_app_option *options, struct ast_flags *flags, char **args, char *optstr);
1027
1028         /*!
1029   \brief Parses a string containing application options and sets flags/arguments.
1030   \param options The array of possible options declared with AST_APP_OPTIONS
1031   \param flags The 64-bit flag structure to have option flags set
1032   \param args The array of argument pointers to hold arguments found
1033   \param optstr The string containing the options to be parsed
1034   \return zero for success, non-zero if an error occurs
1035   \sa AST_APP_OPTIONS
1036  */
1037 int ast_app_parse_options64(const struct ast_app_option *options, struct ast_flags64 *flags, char **args, char *optstr);
1038
1039 /*! \brief Given a list of options array, return an option string based on passed flags
1040         \param options The array of possible options declared with AST_APP_OPTIONS
1041         \param flags The flags of the options that you wish to populate the buffer with
1042         \param buf The buffer to fill with the string of options
1043         \param len The maximum length of buf
1044 */
1045 void ast_app_options2str64(const struct ast_app_option *options, struct ast_flags64 *flags, char *buf, size_t len);
1046
1047 /*! \brief Present a dialtone and collect a certain length extension.
1048     \return Returns 1 on valid extension entered, -1 on hangup, or 0 on invalid extension.
1049 \note Note that if 'collect' holds digits already, new digits will be appended, so be sure it's initialized properly */
1050 int ast_app_dtget(struct ast_channel *chan, const char *context, char *collect, size_t size, int maxlen, int timeout);
1051
1052 /*! \brief Allow to record message and have a review option */
1053 int ast_record_review(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime, const char *fmt, int *duration, const char *path);
1054
1055 /*!\brief Decode an encoded control or extended ASCII character 
1056  * \param[in] stream String to decode
1057  * \param[out] result Decoded character
1058  * \param[out] consumed Number of characters used in stream to encode the character
1059  * \retval -1 Stream is of zero length
1060  * \retval 0 Success
1061  */
1062 int ast_get_encoded_char(const char *stream, char *result, size_t *consumed);
1063
1064 /*!\brief Decode a stream of encoded control or extended ASCII characters
1065  * \param[in] stream Encoded string
1066  * \param[out] result Decoded string
1067  * \param[in] result_len Maximum size of the result buffer
1068  * \return A pointer to the result string
1069  */
1070 char *ast_get_encoded_str(const char *stream, char *result, size_t result_len);
1071
1072 /*! \brief Decode a stream of encoded control or extended ASCII characters */
1073 int ast_str_get_encoded_str(struct ast_str **str, int maxlen, const char *stream);
1074
1075 /*!
1076  * \brief Common routine for child processes, to close all fds prior to exec(2)
1077  * \param[in] n starting file descriptor number for closing all higher file descriptors
1078  * \since 1.6.1
1079  */
1080 void ast_close_fds_above_n(int n);
1081
1082 /*!
1083  * \brief Common routine to safely fork without a chance of a signal handler firing badly in the child
1084  * \param[in] stop_reaper flag to determine if sigchld handler is replaced or not
1085  * \since 1.6.1
1086  */
1087 int ast_safe_fork(int stop_reaper);
1088
1089 /*!
1090  * \brief Common routine to cleanup after fork'ed process is complete (if reaping was stopped)
1091  * \since 1.6.1
1092  */
1093 void ast_safe_fork_cleanup(void);
1094
1095 /*!
1096  * \brief Common routine to parse time lengths, with optional time unit specifier
1097  * \param[in] timestr String to parse
1098  * \param[in] defunit Default unit type
1099  * \param[out] result Resulting value, specified in milliseconds
1100  * \retval 0 Success
1101  * \retval -1 Failure
1102  * \since 1.8
1103  */
1104 int ast_app_parse_timelen(const char *timestr, int *result, enum ast_timelen defunit);
1105
1106 /*!
1107  * \since 12
1108  * \brief Publish a MWI state update via stasis
1109  * \param[in] mailbox The number identifying this mailbox
1110  * \param[in] context The context this mailbox resides in
1111  * \param[in] new_msgs The number of new messages in this mailbox
1112  * \param[in] old_msgs The number of old messages in this mailbox
1113  * \retval 0 Success
1114  * \retval -1 Failure
1115  * \since 12
1116  */
1117 #define ast_publish_mwi_state(mailbox, context, new_msgs, old_msgs) \
1118         ast_publish_mwi_state_full(mailbox, context, new_msgs, old_msgs, NULL, NULL)
1119
1120 /*!
1121  * \since 12
1122  * \brief Publish a MWI state update associated with some channel
1123  * \param[in] mailbox The number identifying this mailbox
1124  * \param[in] context The context this mailbox resides in
1125  * \param[in] new_msgs The number of new messages in this mailbox
1126  * \param[in] old_msgs The number of old messages in this mailbox
1127  * \param[in] channel_id A unique identifier for a channel associated with this
1128  * change in mailbox state
1129  * \retval 0 Success
1130  * \retval -1 Failure
1131  * \since 12
1132  */
1133 #define ast_publish_mwi_state_channel(mailbox, context, new_msgs, old_msgs, channel_id) \
1134         ast_publish_mwi_state_full(mailbox, context, new_msgs, old_msgs, channel_id, NULL)
1135
1136 /*!
1137  * \since 12
1138  * \brief Publish a MWI state update via stasis with all parameters
1139  * \param[in] mailbox The number identifying this mailbox
1140  * \param[in] context The context this mailbox resides in
1141  * \param[in] new_msgs The number of new messages in this mailbox
1142  * \param[in] old_msgs The number of old messages in this mailbox
1143  * \param[in] channel_id A unique identifier for a channel associated with this
1144  * \param[in] eid The EID of the server that originally published the message
1145  * \retval 0 Success
1146  * \retval -1 Failure
1147  * \since 12
1148  */
1149 int ast_publish_mwi_state_full(
1150                         const char *mailbox,
1151                         const char *context,
1152                         int new_msgs,
1153                         int old_msgs,
1154                         const char *channel_id,
1155                         struct ast_eid *eid);
1156
1157 /*! \addtogroup StasisTopicsAndMessages
1158  * @{
1159  */
1160
1161 /*!
1162  * \brief The structure that contains MWI state
1163  * \since 12
1164  */
1165 struct ast_mwi_state {
1166         AST_DECLARE_STRING_FIELDS(
1167                 AST_STRING_FIELD(uniqueid);  /*!< Unique identifier for this mailbox/context */
1168                 AST_STRING_FIELD(mailbox);   /*!< Mailbox for this event */
1169                 AST_STRING_FIELD(context);   /*!< Context that this mailbox belongs to */
1170         );
1171         int new_msgs;                    /*!< The current number of new messages for this mailbox */
1172         int old_msgs;                    /*!< The current number of old messages for this mailbox */
1173         /*! If applicable, a snapshot of the channel that caused this MWI change */
1174         struct ast_channel_snapshot *snapshot;
1175         struct ast_eid eid;              /*!< The EID of the server where this message originated */
1176 };
1177
1178 /*!
1179  * \brief Object that represents an MWI update with some additional application
1180  * defined data
1181  */
1182 struct ast_mwi_blob {
1183         struct ast_mwi_state *mwi_state;    /*!< MWI state */
1184         struct ast_json *blob;              /*!< JSON blob of data */
1185 };
1186
1187 /*!
1188  * \since 12
1189  * \brief Create a \ref ast_mwi_state object
1190  *
1191  * \retval \ref ast_mwi_state object on success
1192  * \retval NULL on error
1193  */
1194 struct ast_mwi_state *ast_mwi_create(const char *mailbox, const char *context);
1195
1196 /*!
1197  * \since 12
1198  * \brief Creates a \ref ast_mwi_blob message.
1199  *
1200  * The \a blob JSON object requires a \c "type" field describing the blob. It
1201  * should also be treated as immutable and not modified after it is put into the
1202  * message.
1203  *
1204  * \param mwi_state MWI state associated with the update
1205  * \param message_type The type of message to create
1206  * \param blob JSON object representing the data.
1207  * \return \ref ast_mwi_blob message.
1208  * \return \c NULL on error
1209  */
1210 struct stasis_message *ast_mwi_blob_create(struct ast_mwi_state *mwi_state,
1211                                            struct stasis_message_type *message_type,
1212                                            struct ast_json *blob);
1213
1214 /*!
1215  * \brief Get the \ref stasis topic for MWI messages
1216  * \retval The topic structure for MWI messages
1217  * \retval NULL if it has not been allocated
1218  * \since 12
1219  */
1220 struct stasis_topic *ast_mwi_topic_all(void);
1221
1222 /*!
1223  * \brief Get the \ref stasis topic for MWI messages on a unique ID
1224  * \param uniqueid The unique id for which to get the topic
1225  * \retval The topic structure for MWI messages for a given uniqueid
1226  * \retval NULL if it failed to be found or allocated
1227  * \since 12
1228  */
1229 struct stasis_topic *ast_mwi_topic(const char *uniqueid);
1230
1231 /*!
1232  * \brief Get the \ref stasis caching topic for MWI messages
1233  * \retval The caching topic structure for MWI messages
1234  * \retval NULL if it has not been allocated
1235  * \since 12
1236  */
1237 struct stasis_caching_topic *ast_mwi_topic_cached(void);
1238
1239 /*!
1240  * \brief Get the \ref stasis message type for MWI messages
1241  * \retval The message type structure for MWI messages
1242  * \retval NULL on error
1243  * \since 12
1244  */
1245 struct stasis_message_type *ast_mwi_state_type(void);
1246
1247 /*!
1248  * \brief Get the \ref stasis message type for voicemail application specific messages
1249  *
1250  * This message type exists for those messages a voicemail application may wish to send
1251  * that have no logical relationship with other voicemail applications. Voicemail apps
1252  * that use this message type must pass a \ref ast_mwi_blob. Any extraneous information
1253  * in the JSON blob must be packed as key/value pair tuples of strings.
1254  *
1255  * At least one key/value tuple must have a key value of "Event".
1256  *
1257  * \retval The \ref stasis_message_type for voicemail application specific messages
1258  * \retval NULL on error
1259  * \since 12
1260  */
1261 struct stasis_message_type *ast_mwi_vm_app_type(void);
1262
1263 /*! @} */
1264
1265 /*!
1266  * \brief Initialize the application core
1267  * \retval 0 Success
1268  * \retval -1 Failure
1269  * \since 12
1270  */
1271 int app_init(void);
1272
1273 #define AST_MAX_MAILBOX_UNIQUEID (AST_MAX_EXTENSION + AST_MAX_CONTEXT + 2)
1274 #if defined(__cplusplus) || defined(c_plusplus)
1275 }
1276 #endif
1277
1278 #endif /* _ASTERISK_APP_H */