app_attended_transfer: new application AttendedTransfer
authorAlexei Gradinari <alex2grad@gmail.com>
Tue, 21 May 2019 19:12:55 +0000 (15:12 -0400)
committerAlexei Gradinari <alex2grad@gmail.com>
Tue, 11 Jun 2019 14:17:06 +0000 (08:17 -0600)
AttendedTransfer queues up attended transfer to the given extension.

This application can be useful with Custom Dynamic Features.
For example to make attended transfer to a predefined number.

features.conf
;;;
[applicationmap]
my_atxfer => *7,self,GoSub,"my_atxfer,s,1",default
;;;

extensions.conf
;;;
[globals]
DYNAMIC_FEATURES=my_atxfer
TRANSFER_CONTEXT=my_transfer

[my_atxfer]
exten => s,1,AttendedTransfer(1234567890)
   same => n,Return()

[my_transfer]
include => default
;;;

This application also can be used to completly redefine Attended transfer
feature using dialplan. For example:

features.conf
;;;
[featuremap]
atxfer => *7

[applicationmap]
custom_atxfer => *2,self,GoSub,"custom_atxfer,s,1",default
;;;

extensions.conf
;;;
[globals]
DYNAMIC_FEATURES=custom_atxfer
TRANSFER_CONTEXT=my_transfer

[custom_atxfer]
exten => s,1,
   same => n,Playback(pbx-transfer)
   same => n,Read(dest,dial,10,i,3,3)
   same => n,AttendedTransfer(${dest})
   same => n,Return()

[my_transfer]
include => default
;;;

Change-Id: Ie5cfa455d0813cffd5c85a6fb117f07d8f0b903b

apps/app_attended_transfer.c [new file with mode: 0644]
doc/CHANGES-staging/app_attended_transfer.txt [new file with mode: 0644]
menuselect/example_menuselect-tree
menuselect/test/menuselect-tree

diff --git a/apps/app_attended_transfer.c b/apps/app_attended_transfer.c
new file mode 100644 (file)
index 0000000..df8d83c
--- /dev/null
@@ -0,0 +1,143 @@
+/*
+ * Asterisk -- An open source telephony toolkit.
+ *
+ * Copyright (C) 2019, Alexei Gradinari
+ *
+ * Alexei Gradinari <alex2grad@gmail.com>
+ *
+ * See http://www.asterisk.org for more information about
+ * the Asterisk project. Please do not directly contact
+ * any of the maintainers of this project for assistance;
+ * the project provides a web site, mailing lists and IRC
+ * channels for your use.
+ *
+ * This program is free software, distributed under the terms of
+ * the GNU General Public License Version 2. See the LICENSE file
+ * at the top of the source tree.
+ */
+
+/*! \file
+ *
+ * \brief Attended transfer by caller channel
+ *
+ * \author Alexei Gradinari <alex2grad@gmail.com>
+ *
+ * \ingroup applications
+ */
+
+/*** MODULEINFO
+       <support_level>extended</support_level>
+ ***/
+
+#include "asterisk.h"
+
+#include "asterisk/pbx.h"
+#include "asterisk/module.h"
+#include "asterisk/app.h"
+#include "asterisk/channel.h"
+#include "asterisk/bridge.h"
+#include "asterisk/features_config.h"
+
+/*** DOCUMENTATION
+       <application name="AttendedTransfer" language="en_US">
+               <synopsis>
+                       Attended transfer to the extension provided and TRANSFER_CONTEXT
+               </synopsis>
+               <syntax>
+                       <parameter name="exten" required="true">
+                               <para>Specify extension.</para>
+                       </parameter>
+               </syntax>
+               <description>
+                       <para>Queue up attended transfer to the specified extension in the <literal>TRANSFER_CONTEXT</literal>.</para>
+                       <para>Note that the attended transfer only work when two channels have answered and are bridged together.</para>
+                       <para>Make sure to set Attended Transfer DTMF feature <literal>atxfer</literal>
+                       and attended transfer is permitted.</para>
+                       <para>The result of the application will be reported in the <variable>ATTENDEDTRANSFERSTATUS</variable>
+                       channel variable:</para>
+                       <variablelist>
+                               <variable name="ATTENDEDTRANSFERSTATUS">
+                                       <value name="SUCCESS">
+                                               Transfer successfully queued.
+                                       </value>
+                                       <value name="FAILURE">
+                                               Transfer failed.
+                                       </value>
+                                       <value name="NOTPERMITTED">
+                                               Transfer not permitted.
+                                       </value>
+                               </variable>
+                       </variablelist>
+               </description>
+       </application>
+ ***/
+
+static const char * const app = "AttendedTransfer";
+
+static int attended_transfer_exec(struct ast_channel *chan, const char *data)
+{
+       char *exten = NULL;
+       const char *context = NULL;
+       char *parse;
+       AST_DECLARE_APP_ARGS(args,
+               AST_APP_ARG(exten);
+       );
+       char feature_code[AST_FEATURE_MAX_LEN];
+       const char *digit;
+       struct ast_frame f = { .frametype = AST_FRAME_DTMF };
+
+       if (ast_strlen_zero((char *)data)) {
+               ast_log(LOG_WARNING, "%s requires an argument (exten)\n", app);
+               pbx_builtin_setvar_helper(chan, "ATTENDEDTRANSFERSTATUS", "FAILURE");
+               return 0;
+       }
+
+       context = pbx_builtin_getvar_helper(chan, "TRANSFER_CONTEXT");
+       if (ast_strlen_zero(context)) {
+               pbx_builtin_setvar_helper(chan, "ATTENDEDTRANSFERSTATUS", "NOTPERMITTED");
+               return 0;
+       }
+
+       ast_channel_lock(chan);
+       if (ast_get_builtin_feature(chan, "atxfer", feature_code, sizeof(feature_code)) ||
+               ast_strlen_zero(feature_code)) {
+               pbx_builtin_setvar_helper(chan, "ATTENDEDTRANSFERSTATUS", "NOTPERMITTED");
+               ast_channel_unlock(chan);
+               return 0;
+       }
+       ast_channel_unlock(chan);
+
+       parse = ast_strdupa(data);
+       AST_STANDARD_APP_ARGS(args, parse);
+
+       exten = args.exten;
+
+       for (digit = feature_code; *digit; ++digit) {
+               f.subclass.integer = *digit;
+               ast_queue_frame(chan, &f);
+       }
+
+       for (digit = exten; *digit; ++digit) {
+               f.subclass.integer = *digit;
+               ast_queue_frame(chan, &f);
+       }
+
+       f.subclass.integer = '#';
+       ast_queue_frame(chan, &f);
+
+       pbx_builtin_setvar_helper(chan, "ATTENDEDTRANSFERSTATUS", "SUCCESS");
+
+       return 0;
+}
+
+static int unload_module(void)
+{
+       return ast_unregister_application(app);
+}
+
+static int load_module(void)
+{
+       return ast_register_application_xml(app, attended_transfer_exec);
+}
+
+AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Attended transfer to the given extension");
diff --git a/doc/CHANGES-staging/app_attended_transfer.txt b/doc/CHANGES-staging/app_attended_transfer.txt
new file mode 100644 (file)
index 0000000..97929e4
--- /dev/null
@@ -0,0 +1,3 @@
+Subject: AttendedTransfer
+
+A new application, this will queue up attended transfer to the given extension.
index 6901b70..e944d67 100644 (file)
@@ -8,6 +8,8 @@
                </member>
                <member name="app_amd" displayname="Answering Machine Detection Application" remove_on_change="apps/app_amd.o apps/app_amd.so">
                </member>
+               <member name="app_attended_transfer" displayname="Attended transfer to the given extension" remove_on_change="apps/app_attended_transfer.o apps/app_attended_transfer.so">
+               </member>
                <member name="app_authenticate" displayname="Authentication Application" remove_on_change="apps/app_authenticate.o apps/app_authenticate.so">
                </member>
                <member name="app_cdr" displayname="Tell Asterisk to not maintain a CDR for the current call" remove_on_change="apps/app_cdr.o apps/app_cdr.so">
index 40c08b6..a8267a8 100644 (file)
@@ -9,6 +9,8 @@
 </member>
 <member name="app_amd" displayname="Answering Machine Detection Application" remove_on_change="apps/app_amd.o apps/app_amd.so">
 </member>
+<member name="app_attended_transfer" displayname="Attended transfer to the given extension" remove_on_change="apps/app_attended_transfer.o apps/app_attended_transfer.so">
+</member>
 <member name="app_authenticate" displayname="Authentication Application" remove_on_change="apps/app_authenticate.o apps/app_authenticate.so">
 </member>
 <member name="app_cdr" displayname="Tell Asterisk to not maintain a CDR for the current call" remove_on_change="apps/app_cdr.o apps/app_cdr.so">