aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authortilghman <tilghman@f38db490-d61c-443f-a65b-d21fe96a405b>2008-08-25 16:02:56 +0000
committertilghman <tilghman@f38db490-d61c-443f-a65b-d21fe96a405b>2008-08-25 16:02:56 +0000
commit938c2edf40ff7a834f12ef2986335f2495576a59 (patch)
treeeb1c002c3b45c39c5dcd6cd1b6535b398ddae884 /doc
parent01fe928c7b53592607efe51a5836e7e7e309c512 (diff)
Realtime capabilities for the Find-Me-Follow-Me application.
(closes issue #13295) Reported by: Corydon76 Patches: 20080813__followme_realtime_enabled.diff.txt uploaded by Corydon76 (license 14) Tested by: dferrer git-svn-id: http://svn.digium.com/svn/asterisk/trunk@139775 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'doc')
-rw-r--r--doc/followme.txt32
1 files changed, 32 insertions, 0 deletions
diff --git a/doc/followme.txt b/doc/followme.txt
new file mode 100644
index 000000000..971814aac
--- /dev/null
+++ b/doc/followme.txt
@@ -0,0 +1,32 @@
+Followme is now realtime-enabled:
+
+To use, you must define two backend data structures, with the following fields:
+
+followme:
+ name Name of this followme entry. Specified when invoking the FollowMe
+ application in the dialplan. This field is the only one which is
+ mandatory. All of the other fields will inherit the default from
+ followme.conf, if not specified in this data resource.
+ musicclass OR The musiconhold class used for the caller while waiting to be
+ musiconhold OR connected.
+ music
+ context Dialplan context from which to dial numbers
+ takecall DTMF used to accept the call and be connected. For obvious reasons,
+ this needs to be a single digit, '*', or '#'.
+ declinecall DTMF used to refuse the call, sending it onto the next step, if any.
+ call_from_prompt Prompt to play to the callee, announcing the call.
+ norecording_prompt The alternate prompt to play to the callee, when the caller
+ refuses to leave a name (or the option isn't set to allow them).
+ options_prompt Normally, "press 1 to accept, 2 to decline".
+ hold_prompt Message played to the caller while dialing the followme steps.
+ status_prompt Normally, "Party is not at their desk".
+ sorry_prompt Normally, "Unable to locate party".
+
+followme_numbers:
+ name Name of this followme entry. Must match the name above.
+ ordinal An integer, specifying the order in which these numbers will be
+ followed.
+ phonenumber The telephone number(s) you would like to call, separated by '&'.
+ timeout Timeout associated with this step. See the followme documentation
+ for more information on how this value is handled.
+