A new xml element was created to manage the AMI actions documentation, using AstXML. To register a manager action using XML documentation it is now possible using ast_manager_register_xml(). The CLI command 'manager show command' can be used to show the parsed documentation. Example manager xml documentation: <manager name="ami action name" language="en_US"> <synopsis> AMI action synopsis. </synopsis> <syntax> <xi:include xpointer="xpointer(...)" /> <-- for ActionID <parameter name="header1" required="true"> <para>Description</para> </parameter> ... </syntax> <description> <para>AMI action description</para> </description> <see-also> ... </see-also> </manager> git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@196308 65c4cc65-6c06-0410-ace0-fbb531ad65f3
157 lines
3.9 KiB
C
157 lines
3.9 KiB
C
/*
|
|
* Asterisk -- An open source telephony toolkit.
|
|
*
|
|
* Copyright (C) 1999 - 2005, Digium, Inc.
|
|
*
|
|
* Mark Spencer <markster@digium.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 App to send DTMF digits
|
|
*
|
|
* \author Mark Spencer <markster@digium.com>
|
|
*
|
|
* \ingroup applications
|
|
*/
|
|
|
|
#include "asterisk.h"
|
|
|
|
ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
|
|
|
|
#include "asterisk/pbx.h"
|
|
#include "asterisk/module.h"
|
|
#include "asterisk/app.h"
|
|
#include "asterisk/manager.h"
|
|
#include "asterisk/channel.h"
|
|
|
|
/*** DOCUMENTATION
|
|
<application name="SendDTMF" language="en_US">
|
|
<synopsis>
|
|
Sends arbitrary DTMF digits
|
|
</synopsis>
|
|
<syntax>
|
|
<parameter name="digits" required="true">
|
|
<para>List of digits 0-9,*#,abcd</para>
|
|
</parameter>
|
|
<parameter name="timeout_ms" required="false">
|
|
<para>Amount of time to wait in ms between tones. (defaults to .25s)</para>
|
|
</parameter>
|
|
<parameter name="duration_ms" required="false">
|
|
<para>Duration of each digit</para>
|
|
</parameter>
|
|
</syntax>
|
|
<description>
|
|
<para>DTMF digits sent to a channel with half second pause</para>
|
|
<para>It will pass all digits or terminate if it encounters an error.</para>
|
|
</description>
|
|
<see-also>
|
|
<ref type="application">Read</ref>
|
|
</see-also>
|
|
</application>
|
|
<manager name="PlayDTMF" language="en_US">
|
|
<synopsis>
|
|
Play DTMF signal on a specific channel.
|
|
</synopsis>
|
|
<syntax>
|
|
<xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
|
|
<parameter name="Channel" required="true">
|
|
<para>Channel name to send digit to.</para>
|
|
</parameter>
|
|
<parameter name="Digit" required="true">
|
|
<para>The DTMF digit to play.</para>
|
|
</parameter>
|
|
</syntax>
|
|
<description>
|
|
<para>Plays a dtmf digit on the specified channel.</para>
|
|
</description>
|
|
</manager>
|
|
***/
|
|
static char *app = "SendDTMF";
|
|
|
|
static int senddtmf_exec(struct ast_channel *chan, const char *vdata)
|
|
{
|
|
int res = 0;
|
|
char *data;
|
|
int timeout = 0, duration = 0;
|
|
AST_DECLARE_APP_ARGS(args,
|
|
AST_APP_ARG(digits);
|
|
AST_APP_ARG(timeout);
|
|
AST_APP_ARG(duration);
|
|
);
|
|
|
|
if (ast_strlen_zero(vdata)) {
|
|
ast_log(LOG_WARNING, "SendDTMF requires an argument (digits or *#aAbBcCdD)\n");
|
|
return 0;
|
|
}
|
|
|
|
data = ast_strdupa(vdata);
|
|
AST_STANDARD_APP_ARGS(args, data);
|
|
|
|
if (!ast_strlen_zero(args.timeout))
|
|
timeout = atoi(args.timeout);
|
|
if (!ast_strlen_zero(args.duration))
|
|
duration = atoi(args.duration);
|
|
res = ast_dtmf_stream(chan, NULL, args.digits, timeout <= 0 ? 250 : timeout, duration);
|
|
|
|
return res;
|
|
}
|
|
|
|
static int manager_play_dtmf(struct mansession *s, const struct message *m)
|
|
{
|
|
const char *channel = astman_get_header(m, "Channel");
|
|
const char *digit = astman_get_header(m, "Digit");
|
|
struct ast_channel *chan;
|
|
|
|
if (!(chan = ast_channel_get_by_name(channel))) {
|
|
astman_send_error(s, m, "Channel not found");
|
|
return 0;
|
|
}
|
|
|
|
if (ast_strlen_zero(digit)) {
|
|
astman_send_error(s, m, "No digit specified");
|
|
chan = ast_channel_unref(chan);
|
|
return 0;
|
|
}
|
|
|
|
ast_senddigit(chan, *digit, 0);
|
|
|
|
chan = ast_channel_unref(chan);
|
|
|
|
astman_send_ack(s, m, "DTMF successfully queued");
|
|
|
|
return 0;
|
|
}
|
|
|
|
static int unload_module(void)
|
|
{
|
|
int res;
|
|
|
|
res = ast_unregister_application(app);
|
|
res |= ast_manager_unregister("PlayDTMF");
|
|
|
|
return res;
|
|
}
|
|
|
|
static int load_module(void)
|
|
{
|
|
int res;
|
|
|
|
res = ast_manager_register_xml("PlayDTMF", EVENT_FLAG_CALL, manager_play_dtmf);
|
|
res |= ast_register_application_xml(app, senddtmf_exec);
|
|
|
|
return res;
|
|
}
|
|
|
|
AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Send DTMF digits Application");
|