diff options
| author | Matt Jordan <mjordan@digium.com> | 2015-09-04 12:25:07 -0500 |
|---|---|---|
| committer | Matt Jordan <mjordan@digium.com> | 2015-09-22 13:27:14 -0500 |
| commit | 4c9f613309d66ae6a8e5454cd53276459bcd2674 (patch) | |
| tree | 2934381535e27f1ca732865d3805a78af7dc06d0 /rest-api | |
| parent | ec514ad64dbc0014525008977c8c74c2856c9d3a (diff) | |
ARI: Add the ability to subscribe to all events
This patch adds the ability to subscribe to all events. There are two possible
ways to accomplish this:
(1) On initial WebSocket connection. This patch adds a new query parameter,
'subscribeAll'. If present and True, Asterisk will subscribe the
applications to all ARI events.
(2) Via the applications resource. When subscribing in this manner, an ARI
client should merely specify a blank resource name, i.e., 'channels:'
instead of 'channels:12354'. This will subscribe the application to all
resources of the 'channels' type.
ASTERISK-24870 #close
Change-Id: I4a943b4db24442cf28bc64b24bfd541249790ad6
Diffstat (limited to 'rest-api')
| -rw-r--r-- | rest-api/api-docs/events.json | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/rest-api/api-docs/events.json b/rest-api/api-docs/events.json index 8d74900f2..6276fc224 100644 --- a/rest-api/api-docs/events.json +++ b/rest-api/api-docs/events.json @@ -26,6 +26,14 @@ "required": true, "allowMultiple": true, "dataType": "string" + }, + { + "name": "subscribeAll", + "description": "Subscribe to all Asterisk events. If provided, the applications listed will be subscribed to all events, effectively disabling the application specific subscriptions. Default is 'false'.", + "paramType": "query", + "required": false, + "allowMultiple": false, + "dataType": "boolean" } ] } |