Misc. Dialplan Tools valet park

From FreeSWITCH Wiki
Jump to: navigation, search

Contents

Description

Places a channel "on hold" in the switch, instead of in the phone. Allows for a number of different options, including:

  • Set caller in a place where the channel won't be hung up on while waiting for someone to talk to.
  • Generic "hold" mechanism, where you transfer a caller to it.

valet_park differs from park in that calls are parked and retrieved with "parking lot" numbers. A call is placed into a parking lot with a blind transfer to a valet_park extension. Calls can be retrieved by calling the same extension. Alternatively, an extension can be set up to ask the caller which parking stall from which to retrieve a call.

Valet parking uses a very simple formula: the first person put into a parking stall will be parked and on hold, listening to hold music. The next person put into (or who dials into) that parking stall will be bridged to the person already parked. The two parties are now bridged and the parking stall is now available.

Examples

Below are several examples of how to implement valet parking.

Blind Transfer

 <action application="valet_park" data="mylot 5555"/>

The above will automatically put the call into "mylot, parking stall number 5555." The next call to this extension will be bridged to the parked caller. Here is a more complete example:

<extension name="valet_parking_dest_ext">
  <condition field="destination_number" expression="^(60\d[1-9])$">
    <action application="answer"/>
    <action application="valet_park" data="valet_lot $1"/>
  </condition>
</extension>

The above example matches calls made to 6001-6099 and automatically performs a valet park on the caller. If no one is in the parking stall then the call is parked, listening to hold music. If someone is already in the parking stall then the two calls are bridge and the parking stall is available again. Here is an example call flow:

Alice answers a call from Bob.
Alice transfers Bob to 6001 and hangs up.
Bob is now in parking stall 6001, hearing MOH.
Alice calls Charlie and tells him that he has a call parked in 6001.
Charlie calls 6001.
Charlie and Bob are now bridged and parking stall 6001 is now empty.

Ask Caller Retrieval

The usage for the ask method is:

 <action application="valet_park" data="[lot] ask [min digits] [max digits] [timeout] [prompt]"/>

This example goes along with the one listed under the blind transfer section above:

<extension name="valet_parking_dest_ext">
  <condition field="destination_number" expression="^(6000)$">
    <action application="answer"/>
    <action application="valet_park" data="valet_lot ask 1 11 10000 ivr/ivr-enter_ext_pound.wav"/>
  </condition>
</extension>

In this case, the one retrieving the parked call will dial 6000 and then dial the stall number and #. Here's the example call flow:

Alice answers a call from Bob.
Alice transfers Bob to 6001 and hangs up.
Bob is now in parking stall 6001, hearing MOH.
Alice calls Charlie and tells him that he has a call parked in 6001.
Charlie calls 6000, waits for prompt, then dials 6001#.
Charlie and Bob are now bridged and parking stall 6001 is now empty.

Having a single extension for park retrieval allows for extra features, like programming a button on phone that dials into the valet parking lot.


Valet Autoselect Parking Stall

You can let the valet choose the slot for you like this:

 <extension name="park-in">
    <condition field="destination_number" expression="^(8500)$">
       <action application="valet_park" data="my_lot auto in 8501 8599"/>
    </condition>
 </extension>

The above extension will find the first stall between 8501 and 8599, park the call there, and then voice the stall number to the transferring user. The call can then be retrieved in the normal fashion by dialing the slot number:

 <extension name="park-out">
   <condition field="destination_number" expression="^(85\d\d)$">
     <action application="answer"/>
     <action application="valet_park" data="my_lot $1"/>
   </condition>
 </extension>

The advantage to this method is that calls parked in this stall will queue up in FIFO fashion, so a receptionist can "stack" calls up and then pop them off one at a time in the order that they were parked.

Bind meta app for transfering

you can add this before any call

<action application="bind_meta_app" data="1 a s valet_park::my_lot auto in 8001 8999"/>

so when on the phone you can dial *1 to park the call to the next free slot 8001-8999

Using Presence

When using git head after October 18, 2011, it is now possible to subscribe to the status of an individual slot or the entire lot. To do this simply subscribe to park+my_lot for the status of the entire lot or park+<slotnumber> to monitor the status of an individual slot. Note that for a multi domain environment the lot name must include the domain name.

For example:

<action application="valet_park" data="my_lot@${domain_name} $1"/>

Events

Custom events with subclass valet_parking::info

hold
bridge
exit

Channel Variables

valet_parking_timeout  - Timeout in Seconds
valet_parking_orbit_exten - Extensions to transfer to when timeout happens.
valet_parking_orbit_dialplan - What dialplan (defaults to current sessions dialplan)
valet_parking_orbit_context - What context (defaults to current sessions context)
valet_announce_slot - Enable/disable the park slot announcement (default announcement is enabled)

API valet_info

Use api valet_info, you can find the status of parking lots. This is can be useful because if you blind transfer a second call to an occupied parking lot, it is connected to the parked call. That means that two customers might talk to each other. A sample output is like this. The lot is park@example.com and parking extension 10 has a call with that uuid.

 <lots>
   <lot name="park@example.com">
     <extension uuid="abcdabcd-1234-5678-1234-1234567890ab">10</extension>
   </lot>
 </lots>

See Also

  • park - traditional park
  • mod_fifo - Alternative means of parking and retrieving calls