switch_ivr.c File Reference

Data Structures
struct	switch_ivr_digit_stream_parser
struct	switch_ivr_digit_stream
Functions
switch_status_t	switch_ivr_sleep (switch_core_session_t *session, uint32_t ms)
	Wait for time to pass for a specified number of milliseconds.
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_parse_event (switch_core_session_t *session, switch_event_t *event)
switch_status_t	switch_ivr_parse_next_event (switch_core_session_t *session)
switch_status_t	switch_ivr_parse_all_events (switch_core_session_t *session)
	Parse all commands from an event.
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 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_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_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 (switch_core_session_t *session)
	Signal the session with a protocol specific unhold 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_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_session_transfer (switch_core_session_t *session, const char *extension, const char *dialplan, const char *context)
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.
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_generate_xml_cdr (switch_core_session_t *session, switch_xml_t *xml_cdr)
	Generate an XML CDR report.
void	switch_ivr_park_session (switch_core_session_t *session)
void	switch_ivr_delay_echo (switch_core_session_t *session, uint32_t delay_ms)
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, switch_input_args_t *args)

---

Function Documentation

switch_status_t switch_ivr_parse_event (  switch_core_session_t *  session, switch_event_t *  event )

{ switch_channel_t *channel = switch_core_session_get_channel(session); char *cmd = switch_event_get_header(event, "call-command"); unsigned long cmd_hash; switch_ssize_t hlen = -1; unsigned long CMD_EXECUTE = switch_hashfunc_default("execute", &hlen); unsigned long CMD_HANGUP = switch_hashfunc_default("hangup", &hlen); unsigned long CMD_NOMEDIA = switch_hashfunc_default("nomedia", &hlen); unsigned long CMD_UNICAST = switch_hashfunc_default("unicast", &hlen); char *lead_frames = switch_event_get_header(event, "lead-frames"); char *event_lock = switch_event_get_header(event, "event-lock"); switch_status_t status = SWITCH_STATUS_FALSE; if (switch_strlen_zero(cmd)) { switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_ERROR, "Invalid Command!\n"); return SWITCH_STATUS_FALSE; } cmd_hash = switch_hashfunc_default(cmd, &hlen); switch_channel_set_flag(channel, CF_EVENT_PARSE); if (switch_true(event_lock)) { switch_channel_set_flag(channel, CF_EVENT_LOCK); } if (lead_frames) { switch_frame_t *read_frame; int frame_count = atoi(lead_frames); int max_frames = frame_count * 2; while(frame_count > 0 && --max_frames > 0) { status = switch_core_session_read_frame(session, &read_frame, SWITCH_IO_FLAG_NONE, 0); if (!SWITCH_READ_ACCEPTABLE(status)) { goto done; } if (!switch_test_flag(read_frame, SFF_CNG)) { frame_count--; } } } if (cmd_hash == CMD_EXECUTE) { const switch_application_interface_t *application_interface; char *app_name = switch_event_get_header(event, "execute-app-name"); char *app_arg = switch_event_get_header(event, "execute-app-arg"); char *loop_h = switch_event_get_header(event, "loops"); char *hold_bleg = switch_event_get_header(event, "hold-bleg"); int loops = 1; if (loop_h) { loops = atoi(loop_h); } if (app_name) { if ((application_interface = switch_loadable_module_get_application_interface(app_name))) { if (application_interface->application_function) { int x; const char *b_uuid = NULL; switch_core_session_t *b_session = NULL; switch_channel_clear_flag(channel, CF_STOP_BROADCAST); switch_channel_set_flag(channel, CF_BROADCAST); if (hold_bleg && switch_true(hold_bleg)) { if ((b_uuid = switch_channel_get_variable(channel, SWITCH_SIGNAL_BOND_VARIABLE))) { const char *stream; b_uuid = switch_core_session_strdup(session, b_uuid); if (!(stream = switch_channel_get_variable_partner(channel, SWITCH_HOLD_MUSIC_VARIABLE))) { stream = switch_channel_get_variable(channel, SWITCH_HOLD_MUSIC_VARIABLE); } if (stream && switch_is_moh(stream)) { if ((b_session = switch_core_session_locate(b_uuid))) { switch_channel_t *b_channel = switch_core_session_get_channel(b_session); switch_ivr_broadcast(b_uuid, stream, SMF_ECHO_ALEG | SMF_LOOP); switch_channel_wait_for_flag(b_channel, CF_BROADCAST, SWITCH_TRUE, 5000); switch_core_session_rwunlock(b_session); } } else { b_uuid = NULL; } } } for (x = 0; x < loops || loops < 0; x++) { switch_time_t b4, aftr; switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_DEBUG, "%s Command Execute %s(%s)\n", switch_channel_get_name(channel), app_name, app_arg); b4 = switch_timestamp_now(); switch_core_session_exec(session, application_interface, app_arg); aftr = switch_timestamp_now(); if (!switch_channel_ready(channel) || switch_channel_test_flag(channel, CF_STOP_BROADCAST) || aftr - b4 < 500000) { break; } } if (b_uuid) { if ((b_session = switch_core_session_locate(b_uuid))) { switch_channel_t *b_channel = switch_core_session_get_channel(b_session); switch_channel_stop_broadcast(b_channel); switch_channel_wait_for_flag(b_channel, CF_BROADCAST, SWITCH_FALSE, 5000); switch_core_session_rwunlock(b_session); } } switch_channel_clear_flag(channel, CF_BROADCAST); } } } } else if (cmd_hash == CMD_UNICAST) { char *local_ip = switch_event_get_header(event, "local-ip"); char *local_port = switch_event_get_header(event, "local-port"); char *remote_ip = switch_event_get_header(event, "remote-ip"); char *remote_port = switch_event_get_header(event, "remote-port"); char *transport = switch_event_get_header(event, "transport"); char *flags = switch_event_get_header(event, "flags"); if (switch_strlen_zero(local_ip)) { local_ip = "127.0.0.1"; } if (switch_strlen_zero(remote_ip)) { remote_ip = "127.0.0.1"; } if (switch_strlen_zero(local_port)) { local_port = "8025"; } if (switch_strlen_zero(remote_port)) { remote_port = "8026"; } if (switch_strlen_zero(transport)) { transport = "udp"; } switch_ivr_activate_unicast(session, local_ip, (switch_port_t)atoi(local_port), remote_ip, (switch_port_t)atoi(remote_port), transport, flags); } else if (cmd_hash == CMD_HANGUP) { char *cause_name = switch_event_get_header(event, "hangup-cause"); switch_call_cause_t cause = SWITCH_CAUSE_NORMAL_CLEARING; if (cause_name) { cause = switch_channel_str2cause(cause_name); } switch_channel_hangup(channel, cause); } else if (cmd_hash == CMD_NOMEDIA) { char *uuid = switch_event_get_header(event, "nomedia-uuid"); switch_ivr_nomedia(uuid, SMF_REBRIDGE); } status = SWITCH_STATUS_SUCCESS; done: switch_channel_clear_flag(channel, CF_EVENT_PARSE); switch_channel_clear_flag(channel, CF_EVENT_LOCK); return status; }

Here is the call graph for this function:

switch_status_t switch_ivr_session_transfer (  switch_core_session_t *  session, const char *  extension, const char *  dialplan, const char *  context )

{ switch_channel_t *channel = switch_core_session_get_channel(session); switch_caller_profile_t *profile, *new_profile; switch_core_session_message_t msg = { 0 }; switch_core_session_t *other_session; switch_channel_t *other_channel = NULL; const char *uuid = NULL; const char *max_forwards; const char *forwardvar = switch_channel_get_variable(channel, SWITCH_MAX_FORWARDS_VARIABLE); int forwardval = 70; if (!switch_strlen_zero(forwardvar)) { forwardval = atoi(forwardvar) - 1; } if (forwardval <= 0) { switch_channel_hangup(channel, SWITCH_CAUSE_EXCHANGE_ROUTING_ERROR); return SWITCH_STATUS_FALSE; } max_forwards = switch_core_session_sprintf(session, "%d", forwardval); switch_channel_set_variable(channel, SWITCH_MAX_FORWARDS_VARIABLE, max_forwards); switch_core_session_reset(session, SWITCH_TRUE); switch_channel_clear_flag(channel, CF_ORIGINATING); /* clear all state handlers */ switch_channel_clear_state_handler(channel, NULL); if ((profile = switch_channel_get_caller_profile(channel))) { if (switch_strlen_zero(dialplan)) { dialplan = profile->dialplan; } if (switch_strlen_zero(context)) { context = profile->context; } if (switch_strlen_zero(dialplan)) { dialplan = "XML"; } if (switch_strlen_zero(context)) { context = "default"; } if (switch_strlen_zero(extension)) { extension = "service"; } new_profile = switch_caller_profile_clone(session, profile); new_profile->dialplan = switch_core_strdup(new_profile->pool, dialplan); new_profile->context = switch_core_strdup(new_profile->pool, context); new_profile->destination_number = switch_core_strdup(new_profile->pool, extension); new_profile->rdnis = switch_core_strdup(new_profile->pool, profile->destination_number); switch_channel_set_variable(channel, SWITCH_SIGNAL_BOND_VARIABLE, NULL); /* If HANGUP_AFTER_BRIDGE is set to 'true', SWITCH_SIGNAL_BRIDGE_VARIABLE * will not have a value, so we need to check SWITCH_BRIDGE_VARIABLE */ uuid = switch_channel_get_variable(channel, SWITCH_SIGNAL_BRIDGE_VARIABLE); if (!uuid) { uuid = switch_channel_get_variable(channel, SWITCH_BRIDGE_VARIABLE); } if (uuid && (other_session = switch_core_session_locate(uuid))) { other_channel = switch_core_session_get_channel(other_session); switch_channel_set_variable(other_channel, SWITCH_SIGNAL_BOND_VARIABLE, NULL); switch_core_session_rwunlock(other_session); } if ((uuid = switch_channel_get_variable(channel, SWITCH_SIGNAL_BRIDGE_VARIABLE)) && (other_session = switch_core_session_locate(uuid))) { other_channel = switch_core_session_get_channel(other_session); switch_channel_set_variable(channel, SWITCH_SIGNAL_BRIDGE_VARIABLE, NULL); switch_channel_set_variable(other_channel, SWITCH_SIGNAL_BRIDGE_VARIABLE, NULL); switch_channel_set_variable(channel, SWITCH_BRIDGE_VARIABLE, NULL); switch_channel_set_variable(other_channel, SWITCH_BRIDGE_VARIABLE, NULL); /* If we are transferring the CALLER out of the bridge, we do not want to hang up on them */ switch_channel_set_variable(channel, SWITCH_HANGUP_AFTER_BRIDGE_VARIABLE, "false"); switch_channel_hangup(other_channel, SWITCH_CAUSE_BLIND_TRANSFER); switch_ivr_media(uuid, SMF_NONE); switch_core_session_rwunlock(other_session); } switch_channel_set_caller_profile(channel, new_profile); switch_channel_set_flag(channel, CF_TRANSFER); switch_channel_set_state(channel, CS_ROUTING); msg.message_id = SWITCH_MESSAGE_INDICATE_TRANSFER; msg.from = __FILE__; switch_core_session_receive_message(session, &msg); switch_log_printf(SWITCH_CHANNEL_LOG, SWITCH_LOG_NOTICE, "Transfer %s to %s[%s@%s]\n", switch_channel_get_name(channel), dialplan, extension, context); return SWITCH_STATUS_SUCCESS; } return SWITCH_STATUS_FALSE; }

Here is the call graph for this function:

---