2013-04-22 14:58:53 +00:00
/*
* Asterisk - - An open source telephony toolkit .
*
* Copyright ( C ) 2012 - 2013 , Digium , Inc .
*
* David M . Lee , II < dlee @ 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 Generated file - declares stubs to be implemented in
2013-07-27 23:11:02 +00:00
* res / ari / resource_endpoints . c
2013-04-22 14:58:53 +00:00
*
* Endpoint resources
*
* \ author David M . Lee , II < dlee @ digium . com >
*/
/*
* ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! !
* ! ! ! ! ! DO NOT EDIT ! ! ! ! !
* ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! !
* This file is generated by a mustache template . Please see the original
2013-07-27 23:11:02 +00:00
* template in rest - api - templates / ari_resource . h . mustache
2013-04-22 14:58:53 +00:00
*/
# ifndef _ASTERISK_RESOURCE_ENDPOINTS_H
# define _ASTERISK_RESOURCE_ENDPOINTS_H
2013-07-27 23:11:02 +00:00
# include "asterisk/ari.h"
2013-04-22 14:58:53 +00:00
2014-07-02 21:13:46 +00:00
/*! Argument struct for ast_ari_endpoints_list() */
2013-11-07 21:10:31 +00:00
struct ast_ari_endpoints_list_args {
2013-04-22 14:58:53 +00:00
} ;
/*!
2013-10-04 16:01:48 +00:00
* \ brief List all endpoints .
2013-04-22 14:58:53 +00:00
*
* \ param headers HTTP headers
* \ param args Swagger parameters
* \ param [ out ] response HTTP response
*/
2013-11-07 21:10:31 +00:00
void ast_ari_endpoints_list ( struct ast_variable * headers , struct ast_ari_endpoints_list_args * args , struct ast_ari_response * response ) ;
Multiple revisions 420089-420090,420097
........
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
2014-08-05 21:44:09 +00:00
/*! Argument struct for ast_ari_endpoints_send_message() */
struct ast_ari_endpoints_send_message_args {
/*! The endpoint resource or technology specific URI to send the message to. Valid resources are sip, pjsip, and xmpp. */
const char * to ;
/*! The endpoint resource or technology specific identity to send this message from. Valid resources are sip, pjsip, and xmpp. */
const char * from ;
/*! The body of the message */
const char * body ;
struct ast_json * variables ;
} ;
/*!
* \ brief Body parsing function for / endpoints / sendMessage .
* \ param body The JSON body from which to parse parameters .
* \ param [ out ] args The args structure to parse into .
* \ retval zero on success
* \ retval non - zero on failure
*/
int ast_ari_endpoints_send_message_parse_body (
struct ast_json * body ,
struct ast_ari_endpoints_send_message_args * args ) ;
/*!
* \ brief Send a message to some technology URI or endpoint .
*
* \ param headers HTTP headers
* \ param args Swagger parameters
* \ param [ out ] response HTTP response
*/
void ast_ari_endpoints_send_message ( struct ast_variable * headers , struct ast_ari_endpoints_send_message_args * args , struct ast_ari_response * response ) ;
2023-05-10 15:53:33 +02:00
/*! Argument struct for ast_ari_endpoints_refer() */
struct ast_ari_endpoints_refer_args {
/*! The endpoint resource or technology specific URI that should be referred to somewhere. Valid resource is pjsip. */
const char * to ;
/*! The endpoint resource or technology specific identity to refer from. */
const char * from ;
/*! The endpoint resource or technology specific URI to refer to. */
const char * refer_to ;
/*! If true and "refer_to" refers to an Asterisk endpoint, the "refer_to" value is set to point to this Asterisk endpoint - so the referee is referred to Asterisk. Otherwise, use the contact URI associated with the endpoint. */
int to_self ;
/*! The "variables" key in the body object holds technology specific key/value pairs to append to the message. These can be interpreted and used by the various resource types; for example, the pjsip resource type will add the key/value pairs as SIP headers. The "display_name" key is used by the PJSIP technology. Its value will be prepended as a display name to the Refer-To URI. */
struct ast_json * variables ;
} ;
/*!
* \ brief Body parsing function for / endpoints / refer .
* \ param body The JSON body from which to parse parameters .
* \ param [ out ] args The args structure to parse into .
* \ retval zero on success
* \ retval non - zero on failure
*/
int ast_ari_endpoints_refer_parse_body (
struct ast_json * body ,
struct ast_ari_endpoints_refer_args * args ) ;
/*!
* \ brief Refer an endpoint or technology URI to some technology URI or endpoint .
*
* \ param headers HTTP headers
* \ param args Swagger parameters
* \ param [ out ] response HTTP response
*/
void ast_ari_endpoints_refer ( struct ast_variable * headers , struct ast_ari_endpoints_refer_args * args , struct ast_ari_response * response ) ;
2014-07-02 21:13:46 +00:00
/*! Argument struct for ast_ari_endpoints_list_by_tech() */
2013-11-07 21:10:31 +00:00
struct ast_ari_endpoints_list_by_tech_args {
2014-07-02 21:13:46 +00:00
/*! Technology of the endpoints (sip,iax2,...) */
2013-05-08 13:39:08 +00:00
const char * tech ;
} ;
/*!
* \ brief List available endoints for a given endpoint technology .
*
* \ param headers HTTP headers
* \ param args Swagger parameters
* \ param [ out ] response HTTP response
*/
2013-11-07 21:10:31 +00:00
void ast_ari_endpoints_list_by_tech ( struct ast_variable * headers , struct ast_ari_endpoints_list_by_tech_args * args , struct ast_ari_response * response ) ;
2014-07-02 21:13:46 +00:00
/*! Argument struct for ast_ari_endpoints_get() */
2013-11-07 21:10:31 +00:00
struct ast_ari_endpoints_get_args {
2014-07-02 21:13:46 +00:00
/*! Technology of the endpoint */
2013-05-08 13:39:08 +00:00
const char * tech ;
2014-07-02 21:13:46 +00:00
/*! ID of the endpoint */
2013-05-08 13:39:08 +00:00
const char * resource ;
2013-04-22 14:58:53 +00:00
} ;
/*!
* \ brief Details for an endpoint .
*
* \ param headers HTTP headers
* \ param args Swagger parameters
* \ param [ out ] response HTTP response
*/
2013-11-07 21:10:31 +00:00
void ast_ari_endpoints_get ( struct ast_variable * headers , struct ast_ari_endpoints_get_args * args , struct ast_ari_response * response ) ;
Multiple revisions 420089-420090,420097
........
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
2014-08-05 21:44:09 +00:00
/*! Argument struct for ast_ari_endpoints_send_message_to_endpoint() */
struct ast_ari_endpoints_send_message_to_endpoint_args {
/*! Technology of the endpoint */
const char * tech ;
/*! ID of the endpoint */
const char * resource ;
/*! The endpoint resource or technology specific identity to send this message from. Valid resources are sip, pjsip, and xmpp. */
const char * from ;
/*! The body of the message */
const char * body ;
struct ast_json * variables ;
} ;
/*!
* \ brief Body parsing function for / endpoints / { tech } / { resource } / sendMessage .
* \ param body The JSON body from which to parse parameters .
* \ param [ out ] args The args structure to parse into .
* \ retval zero on success
* \ retval non - zero on failure
*/
int ast_ari_endpoints_send_message_to_endpoint_parse_body (
struct ast_json * body ,
struct ast_ari_endpoints_send_message_to_endpoint_args * args ) ;
/*!
* \ brief Send a message to some endpoint in a technology .
*
* \ param headers HTTP headers
* \ param args Swagger parameters
* \ param [ out ] response HTTP response
*/
void ast_ari_endpoints_send_message_to_endpoint ( struct ast_variable * headers , struct ast_ari_endpoints_send_message_to_endpoint_args * args , struct ast_ari_response * response ) ;
2023-05-10 15:53:33 +02:00
/*! Argument struct for ast_ari_endpoints_refer_to_endpoint() */
struct ast_ari_endpoints_refer_to_endpoint_args {
/*! Technology of the endpoint */
const char * tech ;
/*! ID of the endpoint */
const char * resource ;
/*! The endpoint resource or technology specific identity to refer from. */
const char * from ;
/*! The endpoint resource or technology specific URI to refer to. */
const char * refer_to ;
/*! If true and "refer_to" refers to an Asterisk endpoint, the "refer_to" value is set to point to this Asterisk endpoint - so the referee is referred to Asterisk. Otherwise, use the contact URI associated with the endpoint. */
int to_self ;
/*! The "variables" key in the body object holds technology specific key/value pairs to append to the message. These can be interpreted and used by the various resource types; for example, the pjsip resource type will add the key/value pairs as SIP headers, */
struct ast_json * variables ;
} ;
/*!
* \ brief Body parsing function for / endpoints / { tech } / { resource } / refer .
* \ param body The JSON body from which to parse parameters .
* \ param [ out ] args The args structure to parse into .
* \ retval zero on success
* \ retval non - zero on failure
*/
int ast_ari_endpoints_refer_to_endpoint_parse_body (
struct ast_json * body ,
struct ast_ari_endpoints_refer_to_endpoint_args * args ) ;
/*!
* \ brief Refer an endpoint or technology URI to some technology URI or endpoint .
*
* \ param headers HTTP headers
* \ param args Swagger parameters
* \ param [ out ] response HTTP response
*/
void ast_ari_endpoints_refer_to_endpoint ( struct ast_variable * headers , struct ast_ari_endpoints_refer_to_endpoint_args * args , struct ast_ari_response * response ) ;
2013-04-22 14:58:53 +00:00
# endif /* _ASTERISK_RESOURCE_ENDPOINTS_H */
