kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-09-03 11:25:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

app_dial: Document DIALSTATUS return values.

Browse Source 
Adds documentation for all of the possible return values
for the DIALSTATUS variable in the Dial application.

ASTERISK-25716

Change-Id: Id22593f1f1f7ea86e5734cee49516ec50848e8c0
This commit is contained in:
Naveen Albert
2022-03-05 12:04:57 +00:00
committed by Kevin Harwell
parent b15d2f9e4b
commit 297ceeb9e4
1 changed files with 29 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
apps/app_dial.c
View File

@@ -613,12 +613,31 @@
</variable> </variable>
<variable name="DIALSTATUS"> <variable name="DIALSTATUS">
<para>This is the status of the call</para> <para>This is the status of the call</para>
<value name="CHANUNAVAIL" /> <value name="CHANUNAVAIL">
<value name="CONGESTION" /> Either the dialed peer exists but is not currently reachable, e.g.
<value name="NOANSWER" /> endpoint is not registered, or an attempt was made to call a
<value name="BUSY" /> nonexistent location, e.g. nonexistent DNS hostname.
<value name="ANSWER" /> </value>
<value name="CANCEL" /> <value name="CONGESTION">
Channel or switching congestion occured when routing the call.
This can occur if there is a slow or no response from the remote end.
</value>
<value name="NOANSWER">
Called party did not answer.
</value>
<value name="BUSY">
The called party was busy or indicated a busy status.
Note that some SIP devices will respond with 486 Busy if their Do Not Disturb
modes are active. In this case, you can use DEVICE_STATUS to check if the
endpoint is actually in use, if needed.
</value>
<value name="ANSWER">
The call was answered.
Any other result implicitly indicates the call was not answered.
</value>
<value name="CANCEL">
Dial was cancelled before call was answered or reached some other terminating event.
</value>
<value name="DONTCALL"> <value name="DONTCALL">
For the Privacy and Screening Modes. For the Privacy and Screening Modes.
Will be set if the called party chooses to send the calling party to the 'Go Away' script. Will be set if the called party chooses to send the calling party to the 'Go Away' script.
@@ -627,7 +646,9 @@
For the Privacy and Screening Modes. For the Privacy and Screening Modes.
Will be set if the called party chooses to send the calling party to the 'torture' script. Will be set if the called party chooses to send the calling party to the 'torture' script.
</value> </value>
<value name="INVALIDARGS" /> <value name="INVALIDARGS">
Dial failed due to invalid syntax.
</value>
</variable> </variable>
</variablelist> </variablelist>
</description> </description>
@@ -3602,4 +3623,4 @@ AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "Dialing Application",
.load = load_module, .load = load_module,
.unload = unload_module, .unload = unload_module,
.requires = "ccss", .requires = "ccss",
); );