-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviewboard.asterisk.org/r/3726/
-----------------------------------------------------------
Review request for Asterisk Developers.
Bugs: ASTERISK-23692 and ASTERISK-23969
https://issues.asterisk.org/jira/browse/ASTERISK-23692
https://issues.asterisk.org/jira/browse/ASTERISK-23969
Repository: Asterisk
Description
-------
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).
The following would send the message "Hello there" to PJSIP endpoint alice with
a display URI of sip:[email protected]:
ari/endpoints/sendMessage?to=pjsip:alice&from=sip:[email protected]&body=Hello+There
This is equivalent to the following as well:
ari/endpoints/PJSIP/alice/sendMessage?from=sip:[email protected]&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. 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:[email protected]>",
"to": "pjsip:[email protected]",
"body": "Watson, come here.",
"variables": []
},
"application": "testsuite"
}
A few interesting things you could do with this:
(1) Build your own XMPP to SIP gateway (without ever touching dialplan)
(2) Make a conferencing application with built-in text messaging (speech to
text would be fun with this... probably should write that too)
(3) WebRTC! SIP stacks in the browser can send MESSAGE requests. Why limit
yourself to just making calls when you can send arbitrary messages to a
communications application? (Note: if you can't mention WebRTC in a release,
you're not trying very hard)
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.
Other administrative notes:
This patch depends on r3760 for the endpoint enhancements. When that patch goes
in, this patch will get updated, which will reduce its size considerably.
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.
Diffs
-----
./branches/12/tests/test_message.c PRE-CREATION
./branches/12/rest-api/api-docs/events.json 418447
./branches/12/rest-api/api-docs/endpoints.json 418447
./branches/12/rest-api/api-docs/applications.json 418447
./branches/12/res/stasis/messaging.c PRE-CREATION
./branches/12/res/stasis/messaging.h PRE-CREATION
./branches/12/res/stasis/app.c 418447
./branches/12/res/res_xmpp.c 418447
./branches/12/res/res_stasis.c 418447
./branches/12/res/res_pjsip_messaging.c 418447
./branches/12/res/res_ari_endpoints.c 418447
./branches/12/res/ari/resource_endpoints.c 418447
./branches/12/res/ari/resource_endpoints.h 418447
./branches/12/res/ari/resource_channels.c 418447
./branches/12/res/ari/resource_applications.h 418447
./branches/12/res/ari/ari_model_validators.c 418447
./branches/12/res/ari/ari_model_validators.h 418447
./branches/12/main/message.c 418447
./branches/12/main/json.c 418447
./branches/12/main/endpoints.c 418447
./branches/12/main/channel_internal_api.c 418447
./branches/12/main/channel.c 418447
./branches/12/include/asterisk/xmpp.h 418447
./branches/12/include/asterisk/vector.h 418447
./branches/12/include/asterisk/message.h 418447
./branches/12/include/asterisk/manager.h 418447
./branches/12/include/asterisk/json.h 418447
./branches/12/include/asterisk/endpoints.h 418447
./branches/12/include/asterisk/channel.h 418447
./branches/12/channels/chan_sip.c 418447
./branches/12/channels/chan_pjsip.c 418447
./branches/12/channels/chan_motif.c 418447
./branches/12/channels/chan_iax2.c 418447
Diff: https://reviewboard.asterisk.org/r/3726/diff/
Testing
-------
Unit tests were added for the message core to make sure dialplan still worked.
Testsuite tests are forthcoming, however, I wanted to make sure this got up on
review board. Feature freeze!
Thanks,
Matt Jordan
--
_____________________________________________________________________
-- Bandwidth and Colocation Provided by http://www.api-digital.com --
asterisk-dev mailing list
To UNSUBSCRIBE or update options visit:
http://lists.digium.com/mailman/listinfo/asterisk-dev
