/* * Asterisk -- An open source telephony toolkit. * * Copyright (C) 1999 - 2005, Digium, Inc. * * Mark Spencer * * 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 transmit a text message * * \author Mark Spencer * * \note Requires support of sending text messages from channel driver * * \ingroup applications */ /*** MODULEINFO core ***/ #include "asterisk.h" #include "asterisk/file.h" #include "asterisk/channel.h" #include "asterisk/pbx.h" #include "asterisk/module.h" #include "asterisk/app.h" #include "asterisk/message.h" /*** DOCUMENTATION Send a Text Message on a channel. Sends text to the current channel. current channel could be the caller or callee depending on the context in which this application is called. The following variables can be set: If set and this channel supports enhanced messaging, this value will be used as the From display name. If set and this channel supports enhanced messaging, this value will be used as the To display name. If set and this channel supports enhanced messaging, this value will be used as the message Content-Type. It MUST be a text/* content type. If not specified, the default of text/plain will be used. If set this value will be used as the message body and any text supplied as a function parameter will be ignored. Result of transmission will be stored in the following variables: No message sent. Message body sent without attributes because the channel driver doesn't support enhanced messaging. The message was sent using enhanced messaging. Transmission succeeded. Transmission failed. Text transmission not supported by channel. The text encoding and transmission method is completely at the discretion of the channel driver. chan_pjsip will use in-dialog SIP MESSAGE messages always. chan_sip will use T.140 via RTP if a text media type was negotiated and in-dialog SIP MESSAGE messages otherwise. Examples: same => n,SendText(Your Text Here) If the channel driver supports enhanced messaging (currently only chan_pjsip), you can set additional variables: same => n,Set(SENDTEXT_FROM_DISPLAYNAME=Really From Bob) same => n,SendText(Your Text Here) same => n,Set(SENDTEXT_CONTENT_TYPE=text/json) same => n,SendText({"foo":a, "bar":23}) same => n,Set(SENDTEXT_CONTENT_TYPE=text/json) same => n,Set(SENDTEXT_BODY={"foo":a, "bar":23}) same => n,SendText() SendImage SendURL ***/ static const char * const app = "SendText"; static int sendtext_exec(struct ast_channel *chan, const char *data) { char *status; char *msg_type; struct ast_str *str; const char *from; const char *to; const char *content_type; const char *body; int rc = 0; ast_channel_lock(chan); from = pbx_builtin_getvar_helper(chan, "SENDTEXT_FROM_DISPLAYNAME"); to = pbx_builtin_getvar_helper(chan, "SENDTEXT_TO_DISPLAYNAME"); content_type = pbx_builtin_getvar_helper(chan, "SENDTEXT_CONTENT_TYPE"); body = S_OR(pbx_builtin_getvar_helper(chan, "SENDTEXT_BODY"), data); body = S_OR(body, ""); if (!(str = ast_str_alloca(strlen(body) + 1))) { rc = -1; goto cleanup; } ast_str_get_encoded_str(&str, -1, body); body = ast_str_buffer(str); msg_type = "NONE"; status = "UNSUPPORTED"; if (ast_channel_tech(chan)->send_text_data) { struct ast_msg_data *msg; struct ast_msg_data_attribute attrs[] = { { .type = AST_MSG_DATA_ATTR_FROM, .value = (char *)S_OR(from, ""), }, { .type = AST_MSG_DATA_ATTR_TO, .value = (char *)S_OR(to, ""), }, { .type = AST_MSG_DATA_ATTR_CONTENT_TYPE, .value = (char *)S_OR(content_type, ""), }, { .type = AST_MSG_DATA_ATTR_BODY, .value = (char *)S_OR(body, ""), }, }; if (!ast_strlen_zero(content_type) && !ast_begins_with(content_type, "text/")) { ast_log(LOG_ERROR, "SENDTEXT_CONTENT_TYPE must begin with 'text/'\n"); rc = -1; goto cleanup; } msg_type = "ENHANCED"; msg = ast_msg_data_alloc(AST_MSG_DATA_SOURCE_TYPE_IN_DIALOG, attrs, ARRAY_LEN(attrs)); if (msg) { if (ast_sendtext_data(chan, msg) == 0) { status = "SUCCESS"; } else { status = "FAILURE"; } ast_free(msg); } else { rc = -1; goto cleanup; } } else if (ast_channel_tech(chan)->send_text) { msg_type = "BASIC"; if (ast_sendtext(chan, body) == 0) { status = "SUCCESS"; } else { status = "FAILURE"; } } pbx_builtin_setvar_helper(chan, "SENDTEXTTYPE", msg_type); pbx_builtin_setvar_helper(chan, "SENDTEXTSTATUS", status); cleanup: pbx_builtin_setvar_helper(chan, "SENDTEXT_FROM_DISPLAYNAME", NULL); pbx_builtin_setvar_helper(chan, "SENDTEXT_TO_DISPLAYNAME", NULL); pbx_builtin_setvar_helper(chan, "SENDTEXT_CONTENT_TYPE", NULL); pbx_builtin_setvar_helper(chan, "SENDTEXT_BODY", NULL); ast_channel_unlock(chan); return rc; } static int unload_module(void) { return ast_unregister_application(app); } static int load_module(void) { return ast_register_application_xml(app, sendtext_exec); } AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Send Text Applications");