47bf7efc4d
........
r420089 | mjordan | 2014-08-05 15:10:52 -0500 (Tue, 05 Aug 2014) | 72 lines
ARI: Add channel technology agnostic out of call text messaging
This patch adds the ability to send and receive text messages from various
technology stacks in Asterisk through ARI. This includes chan_sip (sip),
res_pjsip_messaging (pjsip), and res_xmpp (xmpp). Messages are sent using the
endpoints resource, and can be sent directly through that resource, or to a
particular endpoint.
For example, the following would send the message "Hello there" to PJSIP
endpoint alice with a display URI of sip:asterisk@mycooldomain.org:
ari/endpoints/sendMessage?to=pjsip:alice&from=sip:asterisk@mycooldomain.org&body=Hello+There
This is equivalent to the following as well:
ari/endpoints/PJSIP/alice/sendMessage?from=sip:asterisk@mycooldomain.org&body=Hello+There
Both forms are available for message technologies that allow for arbitrary
destinations, such as chan_sip.
Inbound messages can now be received over ARI as well. An ARI application that
subscribes to endpoints will receive messages from those endpoints:
{
"type": "TextMessageReceived",
"timestamp": "2014-07-12T22:53:13.494-0500",
"endpoint": {
"technology": "PJSIP",
"resource": "alice",
"state": "online",
"channel_ids": []
},
"message": {
"from": "\"alice\" <sip:alice@127.0.0.1>",
"to": "pjsip:asterisk@127.0.0.1",
"body": "Watson, come here.",
"variables": []
},
"application": "testsuite"
}
The above was made possible due to some rather major changes in the message
core. This includes (but is not limited to):
- Users of the message API can now register message handlers. A handler has
two callbacks: one to determine if the handler has a destination for the
message, and another to handle it.
- All dialplan functionality of handling a message was moved into a message
handler provided by the message API.
- Messages can now have the technology/endpoint associated with them.
Various other properties are also now more easily accessible.
- A number of ao2 containers that weren't really needed were replaced with
vectors. Iteration over ao2_containers is expensive and pointless when
the lifetime of things is well defined and the number of things is very
small.
res_stasis now has a new file that makes up its structure, messaging. The
messaging functionality implements a message handler, and passes received
messages that match an interested endpoint over to the app for processing.
Note that inadvertently while testing this, I reproduced ASTERISK-23969.
res_pjsip_messaging was incorrectly parsing out the 'to' field, such that
arbitrary SIP URIs mangled the endpoint lookup. This patch includes the
fix for that as well.
Review: https://reviewboard.asterisk.org/r/3726
ASTERISK-23692 #close
Reported by: Matt Jordan
ASTERISK-23969 #close
Reported by: Andrew Nagy
........
r420090 | mjordan | 2014-08-05 15:16:37 -0500 (Tue, 05 Aug 2014) | 2 lines
Remove automerge properties :-(
........
r420097 | mjordan | 2014-08-05 16:36:25 -0500 (Tue, 05 Aug 2014) | 2 lines
test_message: Fix strict-aliasing compilation issue
........
Merged revisions 420089-420090,420097 from http://svn.asterisk.org/svn/asterisk/branches/12
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@420098 65c4cc65-6c06-0410-ace0-fbb531ad65f3
83 lines
2.4 KiB
C
83 lines
2.4 KiB
C
/*
|
|
* Asterisk -- An open source telephony toolkit.
|
|
*
|
|
* Copyright (C) 2014, Digium, Inc.
|
|
*
|
|
* Matt Jordan <mjordan@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.
|
|
*/
|
|
|
|
#ifndef _ASTERISK_RES_STASIS_MESSAGING_H
|
|
#define _ASTERISK_RES_STASIS_MESSAGING_H
|
|
|
|
/*!
|
|
* \file
|
|
*
|
|
* \brief Stasis out-of-call text message support
|
|
*
|
|
* \author Matt Jordan <mjordan@digium.com>
|
|
* \since 12.4.0
|
|
*/
|
|
|
|
/*!
|
|
* \brief Callback handler for when a message is received from the core
|
|
*
|
|
* \param endpoint_id The ID of the endpoint that we received the message from
|
|
* \param json_msg JSON representation of the text message
|
|
* \param pvt ao2 ref counted pvt passed during registration
|
|
*
|
|
* \retval 0 the message was handled
|
|
* \retval non-zero the message was not handled
|
|
*/
|
|
typedef int (* message_received_cb)(const char *endpoint_id, struct ast_json *json_msg, void *pvt);
|
|
|
|
/*!
|
|
* \brief Subscribe for messages from a particular endpoint
|
|
*
|
|
* \param app_name Name of the stasis application to unsubscribe from messaging
|
|
* \param endpoint_id The ID of the endpoint we no longer care about
|
|
*
|
|
* \retval 0 success
|
|
* \retval -1 error
|
|
*/
|
|
void messaging_app_unsubscribe_endpoint(const char *app_name, const char *endpoint_id);
|
|
|
|
/*!
|
|
* \brief Subscribe an application to an endpoint for messages
|
|
*
|
|
* \param app_name The name of the \ref stasis application to subscribe to \c endpoint
|
|
* \param endpoint The endpoint object to subscribe to
|
|
* \param message_received_cb The callback to call when a message is received
|
|
* \param pvt An ao2 ref counted object that will be passed to the callback.
|
|
*
|
|
* \retval 0 subscription was successful
|
|
* \retval -1 subscription failed
|
|
*/
|
|
int messaging_app_subscribe_endpoint(const char *app_name, struct ast_endpoint *endpoint, message_received_cb callback, void *pvt);
|
|
|
|
/*!
|
|
* \brief Tidy up the messaging layer
|
|
*
|
|
* \retval 0 success
|
|
* \retval -1 failure
|
|
*/
|
|
int messaging_cleanup(void);
|
|
|
|
/*!
|
|
* \brief Initialize the messaging layer
|
|
*
|
|
* \retval 0 success
|
|
* \retval -1 failure
|
|
*/
|
|
int messaging_init(void);
|
|
|
|
#endif /* #define _ASTERISK_RES_STASIS_MESSAGING_H */ |