mirror of
https://github.com/asterisk/asterisk.git
synced 2025-09-04 11:58:52 +00:00
8d7873b836
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
106 lines
2.5 KiB
JSON
106 lines
2.5 KiB
JSON
{
|
|
"_copyright": "Copyright (C) 2012 - 2013, Digium, Inc.",
|
|
"_author": "David M. Lee, II <dlee@digium.com>",
|
|
"_svn_revision": "$Revision$",
|
|
"apiVersion": "0.0.1",
|
|
"swaggerVersion": "1.1",
|
|
"basePath": "http://localhost:8088/stasis",
|
|
"resourcePath": "/api-docs/endpoints.{format}",
|
|
"apis": [
|
|
{
|
|
"path": "/endpoints",
|
|
"description": "Asterisk endpoints",
|
|
"operations": [
|
|
{
|
|
"httpMethod": "GET",
|
|
"summary": "List all endpoints.",
|
|
"nickname": "getEndpoints",
|
|
"responseClass": "List[Endpoint]"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path": "/endpoints/{tech}",
|
|
"description": "Asterisk endpoints",
|
|
"operations": [
|
|
{
|
|
"httpMethod": "GET",
|
|
"summary": "List available endoints for a given endpoint technology.",
|
|
"nickname": "getEndpointsByTech",
|
|
"responseClass": "List[Endpoint]",
|
|
"parameters": [
|
|
{
|
|
"name": "tech",
|
|
"description": "Technology of the endpoints (sip,iax2,...)",
|
|
"paramType": "path",
|
|
"dataType": "string"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"path": "/endpoints/{tech}/{resource}",
|
|
"description": "Single endpoint",
|
|
"operations": [
|
|
{
|
|
"httpMethod": "GET",
|
|
"summary": "Details for an endpoint.",
|
|
"nickname": "getEndpoint",
|
|
"responseClass": "Endpoint",
|
|
"parameters": [
|
|
{
|
|
"name": "tech",
|
|
"description": "Technology of the endpoint",
|
|
"paramType": "path",
|
|
"dataType": "string"
|
|
},
|
|
{
|
|
"name": "resource",
|
|
"description": "ID of the endpoint",
|
|
"paramType": "path",
|
|
"dataType": "string"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"models": {
|
|
"Endpoint": {
|
|
"id": "Endpoint",
|
|
"description": "An external device that may offer/accept calls to/from Asterisk.\n\nUnlike most resources, which have a single unique identifier, an endpoint is uniquely identified by the technology/resource pair.",
|
|
"properties": {
|
|
"technology": {
|
|
"type": "string",
|
|
"description": "Technology of the endpoint",
|
|
"required": true
|
|
},
|
|
"resource": {
|
|
"type": "string",
|
|
"description": "Identifier of the endpoint, specific to the given technology.",
|
|
"required": true
|
|
},
|
|
"state": {
|
|
"type": "string",
|
|
"description": "Endpoint's state",
|
|
"required": false,
|
|
"allowableValues": {
|
|
"valueType": "LIST",
|
|
"values": [
|
|
"unknown",
|
|
"offline",
|
|
"online"
|
|
]
|
|
}
|
|
},
|
|
"channel_ids": {
|
|
"type": "List[string]",
|
|
"description": "Id's of channels associated with this endpoint",
|
|
"required": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|