[Asterisk-code-review] app_dial: Document DIALSTATUS return values. (asterisk[18])

[Friendly Automation]

Friendly Automation has submitted this change. ( https://gerrit.asterisk.org/c/asterisk/+/18220 )

Change subject: app_dial: Document DIALSTATUS return values.
......................................................................

app_dial: Document DIALSTATUS return values.

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

ASTERISK-25716

Change-Id: Id22593f1f1f7ea86e5734cee49516ec50848e8c0
---
M apps/app_dial.c
1 file changed, 29 insertions(+), 8 deletions(-)

Approvals:
  Joshua Colp: Looks good to me, but someone else must approve
  Benjamin Keith Ford: Looks good to me, approved
  Friendly Automation: Approved for Submit



diff --git a/apps/app_dial.c b/apps/app_dial.c
index 33a6931..8be6eff 100644
--- a/apps/app_dial.c
+++ b/apps/app_dial.c
@@ -613,12 +613,31 @@
 				</variable>
 				<variable name="DIALSTATUS">
 					<para>This is the status of the call</para>
-					<value name="CHANUNAVAIL" />
-					<value name="CONGESTION" />
-					<value name="NOANSWER" />
-					<value name="BUSY" />
-					<value name="ANSWER" />
-					<value name="CANCEL" />
+					<value name="CHANUNAVAIL">
+						Either the dialed peer exists but is not currently reachable, e.g.
+						endpoint is not registered, or an attempt was made to call a
+						nonexistent location, e.g. nonexistent DNS hostname.
+					</value>
+					<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">
 						For the Privacy and Screening Modes.
 						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.
 						Will be set if the called party chooses to send the calling party to the 'torture' script.
 					</value>
-					<value name="INVALIDARGS" />
+					<value name="INVALIDARGS">
+						Dial failed due to invalid syntax.
+					</value>
 				</variable>
 			</variablelist>
 		</description>
@@ -3602,4 +3623,4 @@
 	.load = load_module,
 	.unload = unload_module,
 	.requires = "ccss",
-);
\ No newline at end of file
+);

-- 
To view, visit https://gerrit.asterisk.org/c/asterisk/+/18220
To unsubscribe, or for help writing mail filters, visit https://gerrit.asterisk.org/settings

Gerrit-Project: asterisk
Gerrit-Branch: 18
Gerrit-Change-Id: Id22593f1f1f7ea86e5734cee49516ec50848e8c0
Gerrit-Change-Number: 18220
Gerrit-PatchSet: 2
Gerrit-Owner: N A <mail at interlinked.x10host.com>
Gerrit-Reviewer: Benjamin Keith Ford <bford at digium.com>
Gerrit-Reviewer: Friendly Automation
Gerrit-Reviewer: Joshua Colp <jcolp at sangoma.com>
Gerrit-MessageType: merged
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-code-review/attachments/20220323/ad6275c9/attachment.html>