|
Data Structures |
| struct | switch_unicast_conninfo |
Defines |
| #define | SWITCH_IVR_VERIFY_SILENCE_DIVISOR(divisor) |
| #define | switch_ivr_phrase_macro(session, macro_name, data, lang, args) switch_ivr_phrase_macro_event(session, macro_name, data, NULL, lang, args) |
Typedefs |
| typedef switch_unicast_conninfo | switch_unicast_conninfo_t |
| typedef switch_ivr_digit_stream_parser | switch_ivr_digit_stream_parser_t |
| typedef switch_ivr_digit_stream | switch_ivr_digit_stream_t |
| typedef switch_ivr_action_t | switch_ivr_menu_action_function_t (struct switch_ivr_menu *, char *, char *, size_t, void *) |
| typedef switch_ivr_menu | switch_ivr_menu_t |
| typedef switch_ivr_menu_action | switch_ivr_menu_action_t |
| typedef switch_ivr_menu_xml_ctx | switch_ivr_menu_xml_ctx_t |
Enumerations |
| enum | switch_ivr_menu_flags { SWITCH_IVR_MENU_FLAG_FALLTOMAIN = (1 << 0),
SWITCH_IVR_MENU_FLAG_FREEPOOL = (1 << 1),
SWITCH_IVR_MENU_FLAG_STACK = (1 << 2)
} |
| enum | switch_ivr_action_t {
SWITCH_IVR_ACTION_DIE,
SWITCH_IVR_ACTION_EXECMENU,
SWITCH_IVR_ACTION_EXECAPP,
SWITCH_IVR_ACTION_PLAYSOUND,
SWITCH_IVR_ACTION_BACK,
SWITCH_IVR_ACTION_TOMAIN,
SWITCH_IVR_ACTION_NOOP
} |
Functions |
| switch_status_t | switch_ivr_deactivate_unicast (switch_core_session_t *session) |
| switch_status_t | switch_ivr_activate_unicast (switch_core_session_t *session, char *local_ip, switch_port_t local_port, char *remote_ip, switch_port_t remote_port, char *transport, char *flags) |
| switch_status_t | switch_ivr_generate_json_cdr (switch_core_session_t *session, cJSON **json_cdr, switch_bool_t urlencode) |
| | Generate an JSON CDR report.
|
| switch_status_t | switch_ivr_generate_xml_cdr (switch_core_session_t *session, switch_xml_t *xml_cdr) |
| | Generate an XML CDR report.
|
| int | switch_ivr_set_xml_profile_data (switch_xml_t xml, switch_caller_profile_t *caller_profile, int off) |
| int | switch_ivr_set_xml_chan_vars (switch_xml_t xml, switch_channel_t *channel, int off) |
| switch_status_t | switch_ivr_parse_event (_In_ switch_core_session_t *session, _In_ switch_event_t *event) |
| | Parse command from an event.
|
| switch_status_t | switch_ivr_parse_all_events (switch_core_session_t *session) |
| | Parse all commands from an event.
|
| switch_status_t | switch_ivr_parse_next_event (switch_core_session_t *session) |
| switch_status_t | switch_ivr_parse_all_messages (switch_core_session_t *session) |
| switch_status_t | switch_ivr_parse_all_signal_data (switch_core_session_t *session) |
| switch_status_t | switch_ivr_process_indications (switch_core_session_t *session, switch_core_session_message_t *message) |
| switch_status_t | switch_ivr_sleep (switch_core_session_t *session, uint32_t ms, switch_bool_t sync, switch_input_args_t *args) |
| | Wait for time to pass for a specified number of milliseconds.
|
| switch_status_t | switch_ivr_park (switch_core_session_t *session, switch_input_args_t *args) |
| switch_status_t | switch_ivr_collect_digits_callback (switch_core_session_t *session, switch_input_args_t *args, uint32_t digit_timeout, uint32_t abs_timeout) |
| | Wait for DTMF digits calling a pluggable callback function when digits are collected.
|
| switch_status_t | switch_ivr_collect_digits_count (switch_core_session_t *session, char *buf, switch_size_t buflen, switch_size_t maxdigits, const char *terminators, char *terminator, uint32_t first_timeout, uint32_t digit_timeout, uint32_t abs_timeout) |
| | Wait for specified number of DTMF digits, untile terminator is received or until the channel hangs up.
|
| switch_status_t | switch_ivr_play_and_detect_speech (switch_core_session_t *session, const char *file, const char *mod_name, const char *grammar, char **result, uint32_t input_timeout, switch_input_args_t *args) |
| | play a file to the session while doing speech recognition.
|
| switch_status_t | switch_ivr_detect_speech (switch_core_session_t *session, const char *mod_name, const char *grammar, const char *name, const char *dest, switch_asr_handle_t *ah) |
| | Engage background Speech detection on a session.
|
| switch_status_t | switch_ivr_stop_detect_speech (switch_core_session_t *session) |
| | Stop background Speech detection on a session.
|
| switch_status_t | switch_ivr_pause_detect_speech (switch_core_session_t *session) |
| | Pause background Speech detection on a session.
|
| switch_status_t | switch_ivr_resume_detect_speech (switch_core_session_t *session) |
| | Resume background Speech detection on a session.
|
| switch_status_t | switch_ivr_detect_speech_load_grammar (switch_core_session_t *session, char *grammar, char *name) |
| | Load a grammar on a background speech detection handle.
|
| switch_status_t | switch_ivr_detect_speech_unload_grammar (switch_core_session_t *session, const char *name) |
| | Unload a grammar on a background speech detection handle.
|
| switch_status_t | switch_ivr_detect_speech_enable_grammar (switch_core_session_t *session, const char *name) |
| | Enable a grammar on a background speech detection handle.
|
| switch_status_t | switch_ivr_detect_speech_disable_grammar (switch_core_session_t *session, const char *name) |
| | Disable a grammar on a background speech detection handle.
|
| switch_status_t | switch_ivr_detect_speech_disable_all_grammars (switch_core_session_t *session) |
| | Disable all grammars on a background speech detection handle.
|
| switch_status_t | switch_ivr_set_param_detect_speech (switch_core_session_t *session, const char *name, const char *val) |
| switch_status_t | switch_ivr_detect_speech_start_input_timers (switch_core_session_t *session) |
| | Start input timers on a background speech detection handle.
|
| switch_status_t | switch_ivr_record_session (switch_core_session_t *session, char *file, uint32_t limit, switch_file_handle_t *fh) |
| | Record a session to disk.
|
| switch_status_t | switch_ivr_eavesdrop_pop_eavesdropper (switch_core_session_t *session, switch_core_session_t **sessionp) |
| switch_status_t | switch_ivr_eavesdrop_exec_all (switch_core_session_t *session, const char *app, const char *arg) |
| switch_status_t | switch_ivr_eavesdrop_update_display (switch_core_session_t *session, const char *name, const char *number) |
| switch_status_t | switch_ivr_eavesdrop_session (switch_core_session_t *session, const char *uuid, const char *require_group, switch_eavesdrop_flag_t flags) |
| | Eavesdrop on a another session.
|
| switch_status_t | switch_ivr_displace_session (switch_core_session_t *session, const char *file, uint32_t limit, const char *flags) |
| | displace the media for a session with the audio from a file
|
| switch_status_t | switch_ivr_stop_displace_session (switch_core_session_t *session, const char *file) |
| | Stop displacing a session.
|
| switch_status_t | switch_ivr_stop_record_session (switch_core_session_t *session, const char *file) |
| | Stop Recording a session.
|
| switch_status_t | switch_ivr_session_audio (switch_core_session_t *session, const char *cmd, const char *direction, int level) |
| switch_status_t | switch_ivr_stop_session_audio (switch_core_session_t *session) |
| switch_status_t | switch_ivr_inband_dtmf_session (switch_core_session_t *session) |
| | Start looking for DTMF inband.
|
| switch_status_t | switch_ivr_stop_inband_dtmf_session (switch_core_session_t *session) |
| | Stop looking for DTMF inband.
|
| switch_status_t | switch_ivr_inband_dtmf_generate_session (switch_core_session_t *session, switch_bool_t read_stream) |
| | Start generating DTMF inband.
|
| switch_status_t | switch_ivr_stop_inband_dtmf_generate_session (switch_core_session_t *session) |
| | Stop generating DTMF inband.
|
| void | switch_ivr_session_echo (switch_core_session_t *session, switch_input_args_t *args) |
| |
|
| switch_status_t | switch_ivr_stop_tone_detect_session (switch_core_session_t *session) |
| | Stop looking for TONES.
|
| switch_status_t | switch_ivr_tone_detect_session (switch_core_session_t *session, const char *key, const char *tone_spec, const char *flags, time_t timeout, int hits, const char *app, const char *data, switch_tone_detect_callback_t callback) |
| | Start looking for TONES.
|
| switch_status_t | switch_ivr_play_file (switch_core_session_t *session, switch_file_handle_t *fh, const char *file, switch_input_args_t *args) |
| | play a file from the disk to the session
|
| switch_status_t | switch_ivr_wait_for_silence (switch_core_session_t *session, uint32_t thresh, uint32_t silence_hits, uint32_t listen_hits, uint32_t timeout_ms, const char *file) |
| switch_status_t | switch_ivr_gentones (switch_core_session_t *session, const char *script, int32_t loops, switch_input_args_t *args) |
| switch_status_t | switch_ivr_record_file (_In_ switch_core_session_t *session, _In_ switch_file_handle_t *fh, _In_z_ const char *file, _In_opt_ switch_input_args_t *args, _In_ uint32_t limit) |
| | record a file from the session to a file
|
| switch_status_t | switch_play_and_get_digits (switch_core_session_t *session, uint32_t min_digits, uint32_t max_digits, uint32_t max_tries, uint32_t timeout, const char *valid_terminators, const char *audio_file, const char *bad_input_audio_file, const char *var_name, char *digit_buffer, uint32_t digit_buffer_length, const char *digits_regex, uint32_t digit_timeout, const char *transfer_on_failure) |
| | Play a sound and gather digits with the number of retries specified if the user doesn't give digits in the set time.
|
| switch_status_t | switch_ivr_speak_text_handle (switch_core_session_t *session, switch_speech_handle_t *sh, switch_codec_t *codec, switch_timer_t *timer, char *text, switch_input_args_t *args) |
| void | switch_ivr_clear_speech_cache (switch_core_session_t *session) |
| switch_status_t | switch_ivr_speak_text (switch_core_session_t *session, const char *tts_name, const char *voice_name, char *text, switch_input_args_t *args) |
| | Speak given text with given tts engine.
|
| switch_status_t | switch_ivr_originate (switch_core_session_t *session, switch_core_session_t **bleg, switch_call_cause_t *cause, const char *bridgeto, uint32_t timelimit_sec, const switch_state_handler_table_t *table, const char *cid_name_override, const char *cid_num_override, switch_caller_profile_t *caller_profile_override, switch_event_t *ovars, switch_originate_flag_t flags, switch_call_cause_t *cancel_cause) |
| | Make an outgoing call.
|
| switch_status_t | switch_ivr_enterprise_originate (switch_core_session_t *session, switch_core_session_t **bleg, switch_call_cause_t *cause, const char *bridgeto, uint32_t timelimit_sec, const switch_state_handler_table_t *table, const char *cid_name_override, const char *cid_num_override, switch_caller_profile_t *caller_profile_override, switch_event_t *ovars, switch_originate_flag_t flags, switch_call_cause_t *cancel_cause) |
| void | switch_ivr_bridge_display (switch_core_session_t *session, switch_core_session_t *peer_session) |
| switch_status_t | switch_ivr_multi_threaded_bridge (_In_ switch_core_session_t *session, _In_ switch_core_session_t *peer_session, switch_input_callback_function_t dtmf_callback, void *session_data, void *peer_session_data) |
| | Bridge Audio from one session to another.
|
| switch_status_t | switch_ivr_signal_bridge (switch_core_session_t *session, switch_core_session_t *peer_session) |
| | Bridge Signalling from one session to another.
|
| switch_status_t | switch_ivr_session_transfer (_In_ switch_core_session_t *session, const char *extension, const char *dialplan, const char *context) |
| | Transfer an existing session to another location.
|
| uint32_t | switch_ivr_schedule_transfer (time_t runtime, const char *uuid, char *extension, char *dialplan, char *context) |
| | Transfer an existing session to another location in the future.
|
| uint32_t | switch_ivr_schedule_hangup (time_t runtime, const char *uuid, switch_call_cause_t cause, switch_bool_t bleg) |
| | Hangup an existing session in the future.
|
| switch_status_t | switch_ivr_uuid_bridge (const char *originator_uuid, const char *originatee_uuid) |
| | Bridge two existing sessions.
|
| switch_status_t | switch_ivr_media (const char *uuid, switch_media_flag_t flags) |
| | Signal a session to request direct media access to it's remote end.
|
| switch_status_t | switch_ivr_nomedia (const char *uuid, switch_media_flag_t flags) |
| | Signal a session to request indirect media allowing it to exchange media directly with another device.
|
| switch_status_t | switch_ivr_hold_uuid (const char *uuid, const char *message, switch_bool_t moh) |
| | Signal the session with a protocol specific hold message.
|
| switch_status_t | switch_ivr_unhold_uuid (const char *uuid) |
| | Signal the session with a protocol specific unhold message.
|
| switch_status_t | switch_ivr_hold (switch_core_session_t *session, const char *message, switch_bool_t moh) |
| | Signal the session with a protocol specific hold message.
|
| switch_status_t | switch_ivr_unhold (switch_core_session_t *session) |
| | Signal the session with a protocol specific unhold message.
|
| uint32_t | switch_ivr_schedule_broadcast (time_t runtime, const char *uuid, const char *path, switch_media_flag_t flags) |
| | Signal the session to broadcast audio in the future.
|
| switch_status_t | switch_ivr_broadcast (const char *uuid, const char *path, switch_media_flag_t flags) |
| | Signal the session to broadcast audio.
|
| void | switch_ivr_broadcast_in_thread (switch_core_session_t *session, const char *app, int flags) |
| switch_status_t | switch_ivr_transfer_variable (switch_core_session_t *sessa, switch_core_session_t *sessb, char *var) |
| | Transfer variables from one session to another.
|
| switch_status_t | switch_ivr_digit_stream_parser_new (switch_memory_pool_t *pool, switch_ivr_digit_stream_parser_t **parser) |
| | Create a digit stream parser object.
|
| switch_status_t | switch_ivr_digit_stream_parser_destroy (switch_ivr_digit_stream_parser_t *parser) |
| | Destroy a digit stream parser object.
|
| switch_status_t | switch_ivr_digit_stream_new (switch_ivr_digit_stream_parser_t *parser, switch_ivr_digit_stream_t **stream) |
| | Create a new digit stream object.
|
| switch_status_t | switch_ivr_digit_stream_destroy (switch_ivr_digit_stream_t **stream) |
| | Destroys a digit stream object.
|
| switch_status_t | switch_ivr_digit_stream_parser_set_event (switch_ivr_digit_stream_parser_t *parser, char *digits, void *data) |
| | Set a digit string to action mapping.
|
| switch_status_t | switch_ivr_digit_stream_parser_del_event (switch_ivr_digit_stream_parser_t *parser, char *digits) |
| | Delete a string to action mapping.
|
| void * | switch_ivr_digit_stream_parser_feed (switch_ivr_digit_stream_parser_t *parser, switch_ivr_digit_stream_t *stream, char digit) |
| | Feed digits collected into the stream for event match testing.
|
| switch_status_t | switch_ivr_digit_stream_reset (switch_ivr_digit_stream_t *stream) |
| | Reset the collected digit stream to nothing.
|
| switch_status_t | switch_ivr_digit_stream_parser_set_terminator (switch_ivr_digit_stream_parser_t *parser, char digit) |
| | Set a digit string terminator.
|
| switch_status_t | switch_ivr_menu_init (switch_ivr_menu_t **new_menu, switch_ivr_menu_t *main, const char *name, const char *greeting_sound, const char *short_greeting_sound, const char *invalid_sound, const char *exit_sound, const char *confirm_macro, const char *confirm_key, const char *tts_engine, const char *tts_voice, int confirm_attempts, int inter_timeout, int digit_len, int timeout, int max_failures, int max_timeouts, switch_memory_pool_t *pool) |
| | Create a new menu object.
|
| switch_status_t | switch_ivr_menu_bind_action (switch_ivr_menu_t *menu, switch_ivr_action_t ivr_action, const char *arg, const char *bind) |
| | switch_ivr_menu_bind_action: Bind a keystroke to an action.
|
| switch_status_t | switch_ivr_menu_bind_function (switch_ivr_menu_t *menu, switch_ivr_menu_action_function_t *function, const char *arg, const char *bind) |
| | Bind a keystroke to a callback function.
|
| switch_status_t | switch_ivr_menu_execute (switch_core_session_t *session, switch_ivr_menu_t *stack, char *name, void *obj) |
| | Execute a menu.
|
| switch_status_t | switch_ivr_menu_stack_free (switch_ivr_menu_t *stack) |
| | free a stack of menu objects.
|
| switch_status_t | switch_ivr_menu_stack_xml_build (switch_ivr_menu_xml_ctx_t *xml_menu_ctx, switch_ivr_menu_t **menu_stack, switch_xml_t xml_menus, switch_xml_t xml_menu) |
| | Build a menu stack from an xml source.
|
| switch_status_t | switch_ivr_menu_str2action (const char *action_name, switch_ivr_action_t *action) |
| switch_status_t | switch_ivr_menu_stack_xml_add_custom (switch_ivr_menu_xml_ctx_t *xml_menu_ctx, const char *name, switch_ivr_menu_action_function_t *function) |
| switch_status_t | switch_ivr_menu_stack_xml_init (switch_ivr_menu_xml_ctx_t **xml_menu_ctx, switch_memory_pool_t *pool) |
| switch_status_t | switch_ivr_phrase_macro_event (switch_core_session_t *session, const char *macro_name, const char *data, switch_event_t *event, const char *lang, switch_input_args_t *args) |
| void | switch_ivr_delay_echo (switch_core_session_t *session, uint32_t delay_ms) |
| switch_status_t | switch_ivr_find_bridged_uuid (const char *uuid, char *b_uuid, switch_size_t blen) |
| void | switch_ivr_intercept_session (switch_core_session_t *session, const char *uuid, switch_bool_t bleg) |
| void | switch_ivr_park_session (switch_core_session_t *session) |
| switch_status_t | switch_ivr_wait_for_answer (switch_core_session_t *session, switch_core_session_t *peer_session) |
| switch_status_t | switch_ivr_read (switch_core_session_t *session, uint32_t min_digits, uint32_t max_digits, const char *prompt_audio_file, const char *var_name, char *digit_buffer, switch_size_t digit_buffer_length, uint32_t timeout, const char *valid_terminators, uint32_t digit_timeout) |
| switch_status_t | switch_ivr_block_dtmf_session (switch_core_session_t *session) |
| switch_status_t | switch_ivr_unblock_dtmf_session (switch_core_session_t *session) |
| switch_status_t | switch_ivr_bind_dtmf_meta_session (switch_core_session_t *session, uint32_t key, switch_bind_flag_t bind_flags, const char *app) |
| switch_status_t | switch_ivr_unbind_dtmf_meta_session (switch_core_session_t *session, uint32_t key) |
| switch_status_t | switch_ivr_soft_hold (switch_core_session_t *session, const char *unhold_key, const char *moh_a, const char *moh_b) |
| switch_status_t | switch_ivr_say (switch_core_session_t *session, const char *tosay, const char *module_name, const char *say_type, const char *say_method, const char *say_gender, switch_input_args_t *args) |
| switch_status_t | switch_ivr_say_string (switch_core_session_t *session, const char *lang, const char *ext, const char *tosay, const char *module_name, const char *say_type, const char *say_method, const char *say_gender, char **rstr) |
| switch_say_method_t | switch_ivr_get_say_method_by_name (const char *name) |
| switch_say_gender_t | switch_ivr_get_say_gender_by_name (const char *name) |
| switch_say_type_t | switch_ivr_get_say_type_by_name (const char *name) |
| switch_status_t | switch_ivr_say_spell (switch_core_session_t *session, char *tosay, switch_say_args_t *say_args, switch_input_args_t *args) |
| switch_status_t | switch_ivr_say_ip (switch_core_session_t *session, char *tosay, switch_say_callback_t number_func, switch_say_args_t *say_args, switch_input_args_t *args) |
| switch_status_t | switch_ivr_set_user (switch_core_session_t *session, const char *data) |
| switch_status_t | switch_ivr_sound_test (switch_core_session_t *session) |
| void | switch_process_import (switch_core_session_t *session, switch_channel_t *peer_channel, const char *varname, const char *prefix) |
| switch_bool_t | switch_ivr_uuid_exists (const char *uuid) |
| switch_status_t | switch_ivr_dmachine_last_ping (switch_ivr_dmachine_t *dmachine) |
| const char * | switch_ivr_dmachine_get_name (switch_ivr_dmachine_t *dmachine) |
| void | switch_ivr_dmachine_set_match_callback (switch_ivr_dmachine_t *dmachine, switch_ivr_dmachine_callback_t match_callback) |
| void | switch_ivr_dmachine_set_nonmatch_callback (switch_ivr_dmachine_t *dmachine, switch_ivr_dmachine_callback_t nonmatch_callback) |
| switch_status_t | switch_ivr_dmachine_create (switch_ivr_dmachine_t **dmachine_p, const char *name, switch_memory_pool_t *pool, uint32_t digit_timeout, uint32_t input_timeout, switch_ivr_dmachine_callback_t match_callback, switch_ivr_dmachine_callback_t nonmatch_callback, void *user_data) |
| void | switch_ivr_dmachine_destroy (switch_ivr_dmachine_t **dmachine) |
| switch_status_t | switch_ivr_dmachine_bind (switch_ivr_dmachine_t *dmachine, const char *realm, const char *digits, int32_t key, switch_ivr_dmachine_callback_t callback, void *user_data) |
| switch_status_t | switch_ivr_dmachine_feed (switch_ivr_dmachine_t *dmachine, const char *digits, switch_ivr_dmachine_match_t **match) |
| switch_status_t | switch_ivr_dmachine_clear (switch_ivr_dmachine_t *dmachine) |
| switch_status_t | switch_ivr_dmachine_ping (switch_ivr_dmachine_t *dmachine, switch_ivr_dmachine_match_t **match_p) |
| switch_ivr_dmachine_match_t * | switch_ivr_dmachine_get_match (switch_ivr_dmachine_t *dmachine) |
| const char * | switch_ivr_dmachine_get_failed_digits (switch_ivr_dmachine_t *dmachine) |
| void | switch_ivr_dmachine_set_digit_timeout_ms (switch_ivr_dmachine_t *dmachine, uint32_t digit_timeout_ms) |
| void | switch_ivr_dmachine_set_input_timeout_ms (switch_ivr_dmachine_t *dmachine, uint32_t input_timeout_ms) |
| switch_status_t | switch_ivr_dmachine_clear_realm (switch_ivr_dmachine_t *dmachine, const char *realm) |
| switch_status_t | switch_ivr_dmachine_set_realm (switch_ivr_dmachine_t *dmachine, const char *realm) |
| switch_status_t | switch_ivr_get_file_handle (switch_core_session_t *session, switch_file_handle_t **fh) |
| switch_status_t | switch_ivr_release_file_handle (switch_core_session_t *session, switch_file_handle_t **fh) |
| switch_status_t | switch_ivr_process_fh (switch_core_session_t *session, const char *cmd, switch_file_handle_t *fhp) |
| switch_status_t | switch_ivr_insert_file (switch_core_session_t *session, const char *file, const char *insert_file, switch_size_t sample_point) |
| switch_status_t | switch_ivr_create_message_reply (switch_event_t **reply, switch_event_t *message, const char *new_proto) |
| char * | switch_ivr_check_presence_mapping (const char *exten_name, const char *domain_name) |
| switch_status_t | switch_ivr_kill_uuid (const char *uuid, switch_call_cause_t cause) |
| switch_status_t | switch_ivr_blind_transfer_ack (switch_core_session_t *session, switch_bool_t success) |
