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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
|
{
"_copyright": "Copyright (C) 2012 - 2013, Digium, Inc.",
"_author": "David M. Lee, II <dlee@digium.com>",
"_svn_revision": "$Revision$",
"apiVersion": "1.7.0",
"swaggerVersion": "1.1",
"basePath": "http://localhost:8088/ari",
"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/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": 400,
"reason": "Invalid parameters for sending a message."
},
{
"code": 404,
"reason": "Endpoint not found"
}
]
}
]
},
{
"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": 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": {
"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
}
}
},
"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
}
}
}
}
}
|
