mod_fifo variables

About

These are the variables defined for mod_fifo module.

Click here to expand Table of Contents

• 1 fifo_announce
• 2 fifo_bridged
• 3 fifo_caller_consumer_import
• 4 fifo_caller_exit_key
• 5 fifo_chime_freq
• 6 fifo_chime_list
• 7 fifo_consumer_caller_import
• 8 fifo_consumer_exit_key
• 9 fifo_consumer_id
• 10 fifo_consumer_wrapup_key
• 11 fifo_consumer_wrapup_sound
• 12 fifo_consumer_wrapup_time
• 13 fifo_hold_music
• 14 fifo_manual_bridged
• 15 fifo_member_wait
• 16 fifo_orbit_announce
• 17 fifo_orbit_context
• 18 fifo_orbit_exten
• 19 fifo_outbound_uuid
• 20 fifo_override_announce
• 21 fifo_pop_order
• 22 fifo_position
• 23 fifo_record_template
• 24 fifo_role
• 25 fifo_timestamp
• 26 === TEMPLATES ===

fifo_announce

Description needed! Please contribute one.

Usage:

Example needed! Please contribute one.

See also:

Implemented By:

Module Name	Source File	Last Revised
mod_fifo	mod_fifo.c	8689

fifo_bridged

Description goes here

Usage:

Example needed

fifo_caller_consumer_import

Import list of variables from the caller to the consumer.

Usage:

<action application="set" data="fifo_caller_consumer_import=var1,var2"/> 

Implemented By:

Module Name	Source File	Last Revised
mod_fifo	mod_fifo.c	12722

fifo_caller_exit_key

Description needed! Please contribute one.

Usage:

Example needed! Please contribute one.

Implemented By:

Module Name	Source File	Last Revised
mod_fifo	mod_fifo.c	8026

fifo_chime_freq

Description needed! Please contribute one.

Usage:

Example needed! Please contribute one.

Implemented By:

Module Name	Source File	Last Revised
mod_fifo	mod_fifo.c	8026

fifo_chime_list

Description needed! Please contribute one.

Usage:

Example needed! Please contribute one.

Implemented By:

Module Name	Source File	Last Revised
mod_fifo	mod_fifo.c	8026

fifo_consumer_caller_import

Import list of variables from the consumer to the caller

Usage:

<action application="set" data="fifo_consumer_caller_import=var1,var2"/> 

Implemented By:

Module Name	Source File	Last Revised
mod_fifo	mod_fifo.c	12722

fifo_consumer_exit_key

Description needed! Please contribute one.

Usage:

Example needed! Please contribute one.

Implemented By:

Module Name	Source File	Last Revised
mod_fifo	mod_fifo.c	9043

fifo_consumer_id

Description needed! Please contribute one.

Usage:

Example needed! Please contribute one.

Implemented By:

Module Name	Source File	Last Revised
mod_fifo	mod_fifo.c	8026

fifo_consumer_wrapup_key

Description needed! Please contribute one.

Usage:

Example needed! Please contribute one.

Implemented By:

Module Name	Source File	Last Revised
mod_fifo	mod_fifo.c	7961

fifo_consumer_wrapup_sound

Description needed! Please contribute one.

Usage:

Example needed! Please contribute one.

Implemented By:

Module Name	Source File	Last Revised
mod_fifo	mod_fifo.c	7961

fifo_consumer_wrapup_time

Description needed! Please contribute one.

Usage:

Example needed! Please contribute one.

Implemented By:

Module Name	Source File	Last Revised
mod_fifo	mod_fifo.c	9860

fifo_hold_music

Description needed! Please contribute one.

Usage:

Example needed! Please contribute one.

Implemented By:

Module Name	Source File	Last Revised
mod_fifo	mod_fifo.c	8065

fifo_manual_bridged

Description goes here

fifo_member_wait

If it's set to 'wait', then the consumer's leg of the call will not hangup when the caller hangs up [default].
If it's set to 'nowait' then the consumer's leg of the call will hangup when the caller hangs up.

Usage:

<action application="set" data="result=${fifo_member(add MyQueName {fifo_member_wait=nowait}user/1001@VoiceNetwork.ca )"/> 

Implemented By:

Module Name	Source File	Last Revised
mod_fifo	mod_fifo.c	12782

fifo_orbit_announce

Description needed! Please contribute one.

Usage:

Example needed! Please contribute one.

Implemented By:

Module Name	Source File	Last Revised
mod_fifo	mod_fifo.c	8026

fifo_orbit_context

Sets the context for the fifo_orbit_exten when the que times out. This must be set before you place the caller in the que.

Usage:

 <action application="set" data="fifo_orbit_context=MyContext"/>"

Implemented By:

Module Name	Source File	Last Revised
mod_fifo	mod_fifo.c	12782

fifo_orbit_exten

Set a destination extension and timeout, and it will cause FreeSWITCH to run the caller through the FIFO until the specified timeout, then the caller will get transferred to the destination extension. Can be set before launching the caller into the FIFO.

Usage:

Use before a FIFO statement:

<action application="set" data="fifo_orbit_exten=MyFIFOVoicemail:60"/> 

This will cause 60 seconds of time to pass with the caller in the FIFO before sending the call to the Voicemail extension specified.

<action application="fifo" data="MyFIFO in"/> 

Implemented By:

Module Name	Source File	Last Revised
mod_fifo	mod_fifo.c	8026

fifo_outbound_uuid

Description needed! Please contribute one.

Usage:

Example needed! Please contribute one.

Implemented By:

Module Name	Source File	Last Revised
mod_fifo	mod_fifo.c	10277

fifo_override_announce

Description needed! Please contribute one.

Usage:

Example needed! Please contribute one.

Implemented By:

Module Name	Source File	Last Revised
mod_fifo	mod_fifo.c	8014

fifo_pop_order

Description needed! Please contribute one.

Usage:

Example needed! Please contribute one.

Implemented By:

Module Name	Source File	Last Revised
mod_fifo	mod_fifo.c	8689

fifo_position

Description goes here

Usage:

Example needed

Implemented By:

mod_fifo.c

fifo_record_template

Description needed! Please contribute one.

Usage:

Example needed! Please contribute one.

Implemented By:

Module Name	Source File	Last Revised
mod_fifo	mod_fifo.c	8039

fifo_role

For reporting purposes, i.e. in the CDRs, the variable will contain "consumer" or "caller" depending upon the call leg.

Usage:

None

fifo_timestamp

Contains the timestamp of when the caller was bridged to the consumer.

Usage:

None

Implemented By:

Module Name	Source File	Last Revised
mod_fifo	mod_fifo.c	8689

=== TEMPLATES ===

XML_HERE

Module Name	Source File	Last Revised
mod_mod	source_file	9999

Comments:

The variables on this document have been reconciled into the Variables Master List. Posted by ryharris at Feb 07, 2018 13:53