Blocked revisions 200185 via svnmerge
[asterisk/asterisk.git] / doc / followme.txt
1 Followme is now realtime-enabled:
2
3 To use, you must define two backend data structures, with the following fields:
4
5 followme:
6         name                Name of this followme entry.  Specified when invoking the FollowMe
7                             application in the dialplan.  This field is the only one which is
8                             mandatory.  All of the other fields will inherit the default from
9                             followme.conf, if not specified in this data resource.
10         musicclass OR       The musiconhold class used for the caller while waiting to be
11         musiconhold OR      connected.
12     music
13         context             Dialplan context from which to dial numbers
14         takecall            DTMF used to accept the call and be connected.  For obvious reasons,
15                             this needs to be a single digit, '*', or '#'.
16         declinecall         DTMF used to refuse the call, sending it onto the next step, if any.
17         call_from_prompt    Prompt to play to the callee, announcing the call.
18         norecording_prompt  The alternate prompt to play to the callee, when the caller
19                             refuses to leave a name (or the option isn't set to allow them).
20         options_prompt      Normally, "press 1 to accept, 2 to decline".
21         hold_prompt         Message played to the caller while dialing the followme steps.
22         status_prompt       Normally, "Party is not at their desk".
23         sorry_prompt        Normally, "Unable to locate party".
24
25 followme_numbers:
26         name                Name of this followme entry.  Must match the name above.
27         ordinal             An integer, specifying the order in which these numbers will be
28                             followed.
29         phonenumber         The telephone number(s) you would like to call, separated by '&'.
30         timeout             Timeout associated with this step.  See the followme documentation
31                             for more information on how this value is handled.
32