diff options
| author | Matthew Jordan <mjordan@digium.com> | 2013-10-04 16:01:48 +0000 |
|---|---|---|
| committer | Matthew Jordan <mjordan@digium.com> | 2013-10-04 16:01:48 +0000 |
| commit | 8d7873b836999b09caad87abec27579f1f065b84 (patch) | |
| tree | cdf683ab18142553b42102de6c5ca52fc71b22a2 /rest-api/api-docs | |
| parent | b52c972b172087d27178c0e60127d486d4e500f8 (diff) | |
ARI: Add subscription support
This patch adds an /applications API to ARI, allowing explicit management of
Stasis applications.
* GET /applications - list current applications
* GET /applications/{applicationName} - get details of a specific application
* POST /applications/{applicationName}/subscription - explicitly subscribe to
a channel, bridge or endpoint
* DELETE /applications/{applicationName}/subscription - explicitly unsubscribe
from a channel, bridge or endpoint
Subscriptions work by a reference counting mechanism: if you subscript to an
event source X number of times, you must unsubscribe X number of times to stop
receiveing events for that event source.
Review: https://reviewboard.asterisk.org/r/2862
(issue ASTERISK-22451)
Reported by: Matt Jordan
........
Merged revisions 400522 from http://svn.asterisk.org/svn/asterisk/branches/12
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@400523 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'rest-api/api-docs')
| -rw-r--r-- | rest-api/api-docs/endpoints.json | 2 | ||||
| -rw-r--r-- | rest-api/api-docs/events.json | 16 |
2 files changed, 17 insertions, 1 deletions
diff --git a/rest-api/api-docs/endpoints.json b/rest-api/api-docs/endpoints.json index 9d0ff1840..7663a594b 100644 --- a/rest-api/api-docs/endpoints.json +++ b/rest-api/api-docs/endpoints.json @@ -13,7 +13,7 @@ "operations": [ { "httpMethod": "GET", - "summary": "List all endoints.", + "summary": "List all endpoints.", "nickname": "getEndpoints", "responseClass": "List[Endpoint]" } diff --git a/rest-api/api-docs/events.json b/rest-api/api-docs/events.json index a2ac0b3d0..ac3f6521c 100644 --- a/rest-api/api-docs/events.json +++ b/rest-api/api-docs/events.json @@ -293,6 +293,11 @@ "required": true, "type": "Channel", "description": "The channel that signaled the user event." + }, + "userevent": { + "required": true, + "type": "object", + "description": "Custom Userevent data" } } }, @@ -338,6 +343,17 @@ } } }, + "EndpointStateChange": { + "id": "EndpointStateChange", + "extends": "Event", + "description": "Endpoint state changed.", + "properties": { + "endpoint": { + "required": true, + "type": "Endpoint" + } + } + }, "StasisEnd": { "id": "StasisEnd", "extends": "Event", |