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

2 files changed, 174 insertions, 1 deletions

diff --git a/rest-api/api-docs/endpoints.json b/rest-api/api-docs/endpoints.json
index 12b9f2e14..31da6435f 100644
--- a/rest-api/api-docs/endpoints.json
+++ b/rest-api/api-docs/endpoints.json
@@ -20,6 +20,58 @@
 			]
 		},
 		{
+			"path": "/endpoints/sendMessage",
+			"description": "Send a message to some technology URI or endpoint.",
+			"operations": [
+				{
+					"httpMethod": "PUT",
+					"summary": "Send a message to some technology URI or endpoint.",
+					"nickname": "sendMessage",
+					"responseClass": "void",
+					"parameters": [
+						{
+							"name": "to",
+							"description": "The endpoint resource or technology specific URI to send the message to. Valid resources are sip, pjsip, and xmpp.",
+							"paramType": "query",
+							"required": true,
+							"allowMultiple": false,
+							"dataType": "string"
+						},
+						{
+							"name": "from",
+							"description": "The endpoint resource or technology specific identity to send this message from. Valid resources are sip, pjsip, and xmpp.",
+							"paramType": "query",
+							"required": true,
+							"allowMultiple": false,
+							"dataType": "string"
+						},
+						{
+							"name": "body",
+							"description": "The body of the message",
+							"paramType": "query",
+							"required": false,
+							"allowMultiple": false,
+							"dataType": "string"
+						},
+						{
+							"name": "variables",
+							"descriptioni": "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, pjsip and sip resource types will add the key/value pairs as SIP headers,",
+							"paramType": "body",
+							"required": false,
+							"dataType": "containers",
+							"allowMultiple": false
+						}
+					],
+					"errorResponses": [
+						{
+							"code": 404,
+							"reason": "Endpoint not found"
+						}
+					]
+				}
+			]
+		},
+		{
 			"path": "/endpoints/{tech}",
 			"description": "Asterisk endpoints",
 			"operations": [
@@ -70,12 +122,76 @@
 					],
 					"errorResponses": [
 						{
+							"code": 400,
+							"reason": "Invalid parameters for sending a message."
+						},
+						{
 							"code": 404,
 							"reason": "Endpoints not found"
 						}
 					]
 				}
 			]
+		},
+		{
+			"path": "/endpoints/{tech}/{resource}/sendMessage",
+			"description": "Send a message to some endpoint in a technology.",
+			"operations": [
+				{
+					"httpMethod": "PUT",
+					"summary": "Send a message to some endpoint in a technology.",
+					"nickname": "sendMessageToEndpoint",
+					"responseClass": "void",
+					"parameters": [
+						{
+							"name": "tech",
+							"description": "Technology of the endpoint",
+							"paramType": "path",
+							"dataType": "string"
+						},
+						{
+							"name": "resource",
+							"description": "ID of the endpoint",
+							"paramType": "path",
+							"dataType": "string"
+						},
+						{
+							"name": "from",
+							"description": "The endpoint resource or technology specific identity to send this message from. Valid resources are sip, pjsip, and xmpp.",
+							"paramType": "query",
+							"required": true,
+							"allowMultiple": false,
+							"dataType": "string"
+						},
+						{
+							"name": "body",
+							"description": "The body of the message",
+							"paramType": "query",
+							"required": false,
+							"allowMultiple": false,
+							"dataType": "string"
+						},
+						{
+							"name": "variables",
+							"descriptioni": "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, pjsip and sip resource types will add the key/value pairs as SIP headers,",
+							"paramType": "body",
+							"required": false,
+							"dataType": "containers",
+							"allowMultiple": false
+						}
+					],
+					"errorResponses": [
+						{
+							"code": 400,
+							"reason": "Invalid parameters for sending a message."
+						},
+						{
+							"code": 404,
+							"reason": "Endpoint not found"
+						}
+					]
+				}
+			]
 		}
 	],
 	"models": {
@@ -112,6 +228,48 @@
 					"required": true
 				}
 			}
+		},
+		"TextMessageVariable": {
+			"id": "TextMessageVariable",
+			"description": "A key/value pair variable in a text message.",
+			"properties": {
+				"key": {
+					"type": "string",
+					"description": "A unique key identifying the variable.",
+					"required": true
+				},
+				"value": {
+					"type": "string",
+					"description": "The value of the variable.",
+					"required": true
+				}
+			}
+		},
+		"TextMessage": {
+			"id": "TextMessage",
+			"description": "A text message.",
+			"properties": {
+				"from": {
+					"type": "string",
+					"description": "A technology specific URI specifying the source of the message. For sip and pjsip technologies, any SIP URI can be specified. For xmpp, the URI must correspond to the client connection being used to send the message.",
+					"required": true
+				},
+				"to": {
+					"type": "string",
+					"description": "A technology specific URI specifying the destination of the message. Valid technologies include sip, pjsip, and xmp. The destination of a message should be an endpoint.",
+					"required": true
+				},
+				"body": {
+					"type": "string",
+					"description": "The text of the message.",
+					"required": true
+				},
+				"variables": {
+					"type": "List[TextMessageVariable]",
+					"description": "Technology specific key/value pairs associated with the message.",
+					"required": false
+				}
+			}
 		}
 	}
 }
diff --git a/rest-api/api-docs/events.json b/rest-api/api-docs/events.json
index cf93f4b00..5e115fbd2 100644
--- a/rest-api/api-docs/events.json
+++ b/rest-api/api-docs/events.json
@@ -164,7 +164,8 @@
 				"EndpointStateChange",
 				"Dial",
 				"StasisEnd",
-				"StasisStart"
+				"StasisStart",
+				"TextMessageReceived"
 			]
 		},
 		"DeviceStateChanged": {
@@ -671,6 +672,20 @@
 					"type": "Channel"
 				}
 			}
+		},
+		"TextMessageReceived": {
+			"id": "TextMessageReceived",
+			"description": "A text message was received from an endpoint.",
+			"properties": {
+				"message": {
+					"required": true,
+					"type": "TextMessage"
+				},
+				"endpoint": {
+					"required": false,
+					"type": "Endpoint"
+				}
+			}
 		}
 	}
 }