1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
{
"_copyright": "Copyright (C) 2012 - 2013, Digium, Inc.",
"_author": "David M. Lee, II <dlee@digium.com>",
"_svn_revision": "$Revision$",
"apiVersion": "1.2.0",
"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": "list",
"responseClass": "List[Endpoint]"
}
]
},
{
"path": "/endpoints/{tech}",
"description": "Asterisk endpoints",
"operations": [
{
"httpMethod": "GET",
"summary": "List available endoints for a given endpoint technology.",
"nickname": "listByTech",
"responseClass": "List[Endpoint]",
"parameters": [
{
"name": "tech",
"description": "Technology of the endpoints (sip,iax2,...)",
"paramType": "path",
"dataType": "string"
}
],
"errorResponses": [
{
"code": 404,
"reason": "Endpoints not found"
}
]
}
]
},
{
"path": "/endpoints/{tech}/{resource}",
"description": "Single endpoint",
"operations": [
{
"httpMethod": "GET",
"summary": "Details for an endpoint.",
"nickname": "get",
"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"
}
],
"errorResponses": [
{
"code": 404,
"reason": "Endpoints not found"
}
]
}
]
}
],
"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
}
}
}
}
}
|
