[Asterisk-code-review] res/ari/resource_channels.c: Added hangup reason code for channels (...asterisk[master])
Friendly Automation
asteriskteam at digium.com
Thu Jun 27 12:03:36 CDT 2019
Friendly Automation has submitted this change and it was merged. ( https://gerrit.asterisk.org/c/asterisk/+/11287 )
Change subject: res/ari/resource_channels.c: Added hangup reason code for channels
......................................................................
res/ari/resource_channels.c: Added hangup reason code for channels
Currently, DELETE /ari/channels/<channelID> supports only few hangup reasons.
It's good enough for simple use, but when it needs to set the detail reason,
it comes challenges.
Added reason_code query parameter for that.
ASTERISK-28385
Change-Id: I1cf1d991ffd759d0591b347445a55f416ddc3ff2
---
M res/ari/resource_channels.c
M res/ari/resource_channels.h
M res/res_ari_channels.c
M rest-api/api-docs/channels.json
4 files changed, 78 insertions(+), 33 deletions(-)
Approvals:
Kevin Harwell: Looks good to me, approved
Friendly Automation: Approved for Submit
diff --git a/res/ari/resource_channels.c b/res/ari/resource_channels.c
index c195eef..1164ab1 100644
--- a/res/ari/resource_channels.c
+++ b/res/ari/resource_channels.c
@@ -49,6 +49,40 @@
#include <limits.h>
+/*! \brief Return the corresponded hangup code of the given reason */
+static int convert_reason_to_hangup_code(const char* reason)
+{
+ if (!strcmp(reason, "normal")) {
+ return AST_CAUSE_NORMAL;
+ } else if (!strcmp(reason, "busy")) {
+ return AST_CAUSE_BUSY;
+ } else if (!strcmp(reason, "congestion")) {
+ return AST_CAUSE_CONGESTION;
+ } else if (!strcmp(reason, "no_answer")) {
+ return AST_CAUSE_NOANSWER;
+ } else if (!strcmp(reason, "timeout")) {
+ return AST_CAUSE_NO_USER_RESPONSE;
+ } else if (!strcmp(reason, "rejected")) {
+ return AST_CAUSE_CALL_REJECTED;
+ } else if (!strcmp(reason, "unallocated")) {
+ return AST_CAUSE_UNALLOCATED;
+ } else if (!strcmp(reason, "normal_unspecified")) {
+ return AST_CAUSE_NORMAL_UNSPECIFIED;
+ } else if (!strcmp(reason, "number_incomplete")) {
+ return AST_CAUSE_INVALID_NUMBER_FORMAT;
+ } else if (!strcmp(reason, "codec_mismatch")) {
+ return AST_CAUSE_BEARERCAPABILITY_NOTAVAIL;
+ } else if (!strcmp(reason, "interworking")) {
+ return AST_CAUSE_INTERWORKING;
+ } else if (!strcmp(reason, "failure")) {
+ return AST_CAUSE_FAILURE;
+ } else if(!strcmp(reason, "answered_elsewhere")) {
+ return AST_CAUSE_ANSWERED_ELSEWHERE;
+ }
+
+ return -1;
+}
+
/*!
* \brief Ensure channel is in a state that allows operation to be performed.
*
@@ -885,39 +919,34 @@
return;
}
- if (ast_strlen_zero(args->reason) || !strcmp(args->reason, "normal")) {
- cause = AST_CAUSE_NORMAL;
- } else if (!strcmp(args->reason, "busy")) {
- cause = AST_CAUSE_BUSY;
- } else if (!strcmp(args->reason, "congestion")) {
- cause = AST_CAUSE_CONGESTION;
- } else if (!strcmp(args->reason, "no_answer")) {
- cause = AST_CAUSE_NOANSWER;
- } else if (!strcmp(args->reason, "timeout")) {
- cause = AST_CAUSE_NO_USER_RESPONSE;
- } else if (!strcmp(args->reason, "rejected")) {
- cause = AST_CAUSE_CALL_REJECTED;
- } else if (!strcmp(args->reason, "unallocated")) {
- cause = AST_CAUSE_UNALLOCATED;
- } else if (!strcmp(args->reason, "normal_unspecified")) {
- cause = AST_CAUSE_NORMAL_UNSPECIFIED;
- } else if (!strcmp(args->reason, "number_incomplete")) {
- cause = AST_CAUSE_INVALID_NUMBER_FORMAT;
- } else if (!strcmp(args->reason, "codec_mismatch")) {
- cause = AST_CAUSE_BEARERCAPABILITY_NOTAVAIL;
- } else if (!strcmp(args->reason, "interworking")) {
- cause = AST_CAUSE_INTERWORKING;
- } else if (!strcmp(args->reason, "failure")) {
- cause = AST_CAUSE_FAILURE;
- } else if(!strcmp(args->reason, "answered_elsewhere")) {
- cause = AST_CAUSE_ANSWERED_ELSEWHERE;
- } else {
- ast_ari_response_error(
- response, 400, "Invalid Reason",
- "Invalid reason for hangup provided");
+ if (!ast_strlen_zero(args->reason) && !ast_strlen_zero(args->reason_code)) {
+ ast_ari_response_error(response, 400, "Bad Request",
+ "The reason and reason_code can't both be specified");
return;
}
+ if (!ast_strlen_zero(args->reason_code)) {
+ /* reason_code allows any hangup code */
+ if (sscanf(args->reason_code, "%30d", &cause) != 1) {
+ ast_ari_response_error(
+ response, 400, "Invalid Reason Code",
+ "Invalid reason for hangup reason code provided");
+ return;
+ }
+ } else if (!ast_strlen_zero(args->reason)) {
+ /* reason allows only listed hangup reason */
+ cause = convert_reason_to_hangup_code(args->reason);
+ if (cause == -1) {
+ ast_ari_response_error(
+ response, 400, "Invalid Reason",
+ "Invalid reason for hangup reason provided");
+ return;
+ }
+ } else {
+ /* not specified. set default hangup */
+ cause = AST_CAUSE_NORMAL;
+ }
+
ast_channel_hangupcause_set(chan, cause);
ast_softhangup(chan, AST_SOFTHANGUP_EXPLICIT);
diff --git a/res/ari/resource_channels.h b/res/ari/resource_channels.h
index 401c8a5..8aefb40 100644
--- a/res/ari/resource_channels.h
+++ b/res/ari/resource_channels.h
@@ -207,7 +207,9 @@
struct ast_ari_channels_hangup_args {
/*! Channel's id */
const char *channel_id;
- /*! Reason for hanging up the channel */
+ /*! The reason code for hanging up the channel for detail use. Mutually exclusive with 'reason'. See detail hangup codes at here. https://wiki.asterisk.org/wiki/display/AST/Hangup+Cause+Mappings */
+ const char *reason_code;
+ /*! Reason for hanging up the channel for simple use. Mutually exclusive with 'reason_code'. */
const char *reason;
};
/*!
diff --git a/res/res_ari_channels.c b/res/res_ari_channels.c
index 73d1e4b..825d4c2 100644
--- a/res/res_ari_channels.c
+++ b/res/res_ari_channels.c
@@ -598,6 +598,10 @@
{
struct ast_json *field;
/* Parse query parameters out of it */
+ field = ast_json_object_get(body, "reason_code");
+ if (field) {
+ args->reason_code = ast_json_string_get(field);
+ }
field = ast_json_object_get(body, "reason");
if (field) {
args->reason = ast_json_string_get(field);
@@ -625,6 +629,9 @@
#endif /* AST_DEVMODE */
for (i = get_params; i; i = i->next) {
+ if (strcmp(i->name, "reason_code") == 0) {
+ args.reason_code = (i->value);
+ } else
if (strcmp(i->name, "reason") == 0) {
args.reason = (i->value);
} else
diff --git a/rest-api/api-docs/channels.json b/rest-api/api-docs/channels.json
index 4ea5f56..7741269 100644
--- a/rest-api/api-docs/channels.json
+++ b/rest-api/api-docs/channels.json
@@ -407,13 +407,20 @@
"dataType": "string"
},
{
+ "name": "reason_code",
+ "description": "The reason code for hanging up the channel for detail use. Mutually exclusive with 'reason'. See detail hangup codes at here. https://wiki.asterisk.org/wiki/display/AST/Hangup+Cause+Mappings",
+ "paramType": "query",
+ "required": false,
+ "allowMultiple": false,
+ "dataType": "string"
+ },
+ {
"name": "reason",
- "description": "Reason for hanging up the channel",
+ "description": "Reason for hanging up the channel for simple use. Mutually exclusive with 'reason_code'.",
"paramType": "query",
"required": false,
"allowMultiple": false,
"dataType": "string",
- "defalutValue": "normal",
"allowableValues": {
"valueType": "LIST",
"values": [
--
To view, visit https://gerrit.asterisk.org/c/asterisk/+/11287
To unsubscribe, or for help writing mail filters, visit https://gerrit.asterisk.org/settings
Gerrit-Project: asterisk
Gerrit-Branch: master
Gerrit-Change-Id: I1cf1d991ffd759d0591b347445a55f416ddc3ff2
Gerrit-Change-Number: 11287
Gerrit-PatchSet: 5
Gerrit-Owner: sungtae kim <pchero21 at gmail.com>
Gerrit-Reviewer: Benjamin Keith Ford <bford at digium.com>
Gerrit-Reviewer: Friendly Automation
Gerrit-Reviewer: Joshua Colp <jcolp at digium.com>
Gerrit-Reviewer: Kevin Harwell <kharwell at digium.com>
Gerrit-Reviewer: sungtae kim <pchero21 at gmail.com>
Gerrit-MessageType: merged
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-code-review/attachments/20190627/1edf72ee/attachment.html>
More information about the asterisk-code-review
mailing list