Sapian
/
asterisk
mirror of http://gerrit.asterisk.org/asterisk
3
0
Fork 0
Code Issues Releases Wiki Activity

Update dial documentation (bug #2096)

Browse Source 
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@3481 65c4cc65-6c06-0410-ace0-fbb531ad65f3
1.0
Mark Spencer 21 years ago
parent d3397cd37d
commit 24a5704798
2 changed files with 32 additions and 14 deletions
Show Stats Download Patch File Download Diff File

37
apps/app_dial.c
Unescape View File

@ -61,8 +61,9 @@ static char *descrip =
"The option string may contain zero or more of the following characters:\n" "The option string may contain zero or more of the following characters:\n"
" 't' -- allow the called user transfer the calling user by hitting #.\n" " 't' -- allow the called user transfer the calling user by hitting #.\n"
" 'T' -- allow the calling user to transfer the call by hitting #.\n" " 'T' -- allow the calling user to transfer the call by hitting #.\n"
" 'f' -- Forces callerid to be set as the extension of the line making/redirecting the outgoing call.\n" " 'f' -- Forces callerid to be set as the extension of the line \n"
" For example, some PSTNs don't allow callerids from other extensions then the ones\n" " making/redirecting the outgoing call. For example, some PSTNs\n"
" don't allow callerids from other extensions then the ones\n"
" that are assigned to you.\n" " that are assigned to you.\n"
" 'r' -- indicate ringing to the calling party, pass no audio until answered.\n" " 'r' -- indicate ringing to the calling party, pass no audio until answered.\n"
" 'm' -- provide hold music to the calling party until answered.\n" " 'm' -- provide hold music to the calling party until answered.\n"
@ -73,20 +74,28 @@ static char *descrip =
" 'A(x)' -- play an announcement to the called party, using x as file\n" " 'A(x)' -- play an announcement to the called party, using x as file\n"
" 'S(x)' -- hangup the call after x seconds AFTER called party picked up\n" " 'S(x)' -- hangup the call after x seconds AFTER called party picked up\n"
" 'D([digits])' -- Send DTMF digit string *after* called party has answered\n" " 'D([digits])' -- Send DTMF digit string *after* called party has answered\n"
" but before the bridge. (w=500ms sec pause)\n" " but before the bridge. (w=500ms sec pause)\n"
" 'L(x[:y][:z])' -- Limit the call to 'x' ms warning when 'y' ms are left (repeated every 'z' ms)\n" " 'L(x[:y][:z])' -- Limit the call to 'x' ms warning when 'y' ms are left\n"
" -- Only 'x' is required, 'y' and 'z' are optional.\n" " repeated every 'z' ms) Only 'x' is required, 'y' and 'z' are optional.\n"
" -- The following special variables are optional:\n" " The following special variables are optional:\n"
" ** LIMIT_PLAYAUDIO_CALLER (default yes) Play sounds to the caller.\n" " * LIMIT_PLAYAUDIO_CALLER yes|no (default yes)\n"
" ** LIMIT_PLAYAUDIO_CALLEE Play sounds to the callee.\n" " Play sounds to the caller.\n"
" ** LIMIT_TIMEOUT_FILE File to play when time is up.\n" " * LIMIT_PLAYAUDIO_CALLEE yes|no\n"
" ** LIMIT_CONNECT_FILE File to play when call begins.\n" " Play sounds to the callee.\n"
" ** LIMIT_WARNING_FILE File to play as warning if 'y' is defined.\n" " * LIMIT_TIMEOUT_FILE File to play when time is up.\n"
" -- 'timeleft' is a special sound macro to auto-say the time left and is the default.\n\n" " * LIMIT_CONNECT_FILE File to play when call begins.\n"
" * LIMIT_WARNING_FILE File to play as warning if 'y' is defined.\n"
" 'timeleft' is a special sound macro to auto-say the time \n"
" left and is the default.\n\n"
" In addition to transferring the call, a call may be parked and then picked\n" " In addition to transferring the call, a call may be parked and then picked\n"
"up by another user.\n" "up by another user.\n"
" The optional URL will be sent to the called party if the channel supports\n" " The optional URL will be sent to the called party if the channel supports it.\n"
"it.\n"; " This application sets the following channel variables upon completion:\n"
" DIALEDTIME Time from dial to answer\n"
" ANSWEREDTIME Time for actual call\n"
" DIALSTATUS The status of the call as a text string, one of\n"
" CHANUNAVAIL | CONGESTION | NOANSWER | BUSY | ANSWER | CANCEL\n"
"";
/* We define a customer "local user" structure because we /* We define a customer "local user" structure because we
use it not only for keeping track of what is in use but use it not only for keeping track of what is in use but

9
doc/README.variables
Unescape View File

@ -74,6 +74,15 @@ ${TIMESTAMP} Current date time in the format: YYYYMMDD-HHMMSS
${TXTCIDNAME} Result of application TXTCIDName ${TXTCIDNAME} Result of application TXTCIDName
${UNIQUEID} Current call unique identifier ${UNIQUEID} Current call unique identifier
The dial() application sets the following variables:
${DIALEDPEERNAME} Dialed peer name
${DIALEDPEERNUMBER} Dialed peer number
${DIALEDTIME} Time for the call (seconds)
${ANSWEREDTIME} Time from dial to answer (seconds)
${DIALSTATUS} Status of the call, one of:
CHANUNAVAIL | CONGESTION | BUSY | NOANSWER | ANSWER | CANCEL
There are two reference modes - reference by value and reference by name. There are two reference modes - reference by value and reference by name.
To refer to a variable with its name (as an argument to a function that To refer to a variable with its name (as an argument to a function that
requires a variable), just write the name. To refer to the variable's value, requires a variable), just write the name. To refer to the variable's value,

Write Preview
Loading…
Cancel
Save