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
|
{
"_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/events.{format}",
"apis": [
{
"path": "/events",
"description": "Events from Asterisk to applications",
"operations": [
{
"httpMethod": "GET",
"summary": "WebSocket connection for events.",
"nickname": "eventWebsocket",
"responseClass": "Event",
"parameters": [
{
"name": "app",
"description": "Comma seperated list of applications to subscribe to.",
"paramType": "query",
"required": true,
"allowMultiple": true,
"dataType": "string"
},
{
"name": "Upgrade",
"description": "RFC6455 header for upgrading a connection to a websocket.",
"paramType": "header",
"required": true,
"dataType": "string",
"allowableValues": {
"valueType": "LIST",
"values": [
"websocket"
]
}
}
]
}
]
}
],
"models": {
"Event": {
"id": "Event",
"description": "Asynchronous events from Asterisk. The non-required fields of this object are mutually exclusive.",
"properties": {
"application": {
"type": "string",
"description": "Name of the application receiving the event.",
"required": true
},
"application_replaced": { "type": "ApplicationReplaced" },
"channel_created": { "type": "ChannelCreated" },
"channel_destroyed": { "type": "ChannelDestroyed" },
"channel_snapshot": { "type": "ChannelSnapshot" },
"channel_state_change": { "type": "ChannelStateChange" },
"channel_dtmf_received": { "type": "ChannelDtmfReceived" },
"channel_dialplan": { "type": "ChannelDialplan" },
"channel_caller_id": { "type": "ChannelCallerId" },
"channel_userevent": { "type": "ChannelUserevent" },
"channel_hangup_request": { "type": "ChannelHangupRequest" },
"channel_varset": { "type": "ChannelVarset" },
"stasis_end": { "type": "StasisEnd" },
"stasis_start": { "type": "StasisStart" }
}
},
"ApplicationReplaced": {
"id": "ApplicationReplaced",
"description": "Notification that another WebSocket has taken over for an application.",
"notes": "An application may only be subscribed to by a single WebSocket at a time. If multiple WebSockets attempt to subscribe to the same application, the newer WebSocket wins, and the older one receives this event.",
"properties": {
"application": {
"required": true,
"type": "string"
}
}
},
"ChannelCreated": {
"id": "ChannelCreated",
"description": "Notification that a channel has been created.",
"properties": {
"channel": {
"required": true,
"type": "Channel"
}
}
},
"ChannelSnapshot": {
"id": "ChannelSnapshot",
"description": "Some part of channel state changed.",
"properties": {
"channel": {
"required": true,
"type": "Channel"
}
}
},
"ChannelDestroyed": {
"id": "ChannelDestroyed",
"description": "Notification that a channel has been destroyed.",
"properties": {
"cause": {
"required": true,
"description": "Integer representation of the cause of the hangup",
"type": "integer"
},
"cause_txt": {
"required": true,
"description": "Text representation of the cause of the hangup",
"type": "string"
},
"channel": {
"required": true,
"type": "Channel"
}
}
},
"ChannelStateChange": {
"id": "ChannelStateChange",
"description": "Notification of a channel's state change.",
"properties": {
"channel": {
"required": true,
"type": "Channel"
}
}
},
"ChannelDtmfReceived": {
"id": "ChannelDtmfReceived",
"description": "DTMF received on a channel.",
"notes": "This event is sent when the DTMF ends. There is no notification about the start of DTMF",
"properties": {
"digit": {
"required": true,
"type": "string",
"description": "DTMF digit received (0-9, A-E, # or *)"
},
"channel": {
"required": true,
"type": "Channel",
"description": "The channel on which DTMF was received"
}
}
},
"ChannelDialplan": {
"id": "ChannelDialplan",
"description": "Channel changed location in the dialplan.",
"properties": {
"application": {
"required": true,
"type": "string",
"description": "The application that the channel is currently in."
},
"application_data": {
"required": true,
"type": "string",
"description": "The data that was passed to the application when it was invoked."
},
"channel": {
"required": true,
"type": "Channel",
"description": "The channel that changed dialplan location."
}
}
},
"ChannelCallerId": {
"id": "ChannelCallerId",
"description": "Channel changed Caller ID.",
"properties": {
"caller_presentation": {
"required": true,
"type": "integer",
"description": "The integer representation of the Caller Presentation value."
},
"caller_presentation_txt": {
"required": true,
"type": "string",
"description": "The text representation of the Caller Presentation value."
},
"channel": {
"required": true,
"type": "Channel",
"description": "The channel that changed Caller ID."
}
}
},
"ChannelUserevent": {
"id": "ChannelUserevent",
"description": "User-generated event with additional user-defined fields in the object.",
"properties": {
"eventname": {
"required": true,
"type": "string",
"description": "The name of the user event."
},
"channel": {
"required": true,
"type": "Channel",
"description": "The channel that signaled the user event."
}
}
},
"ChannelHangupRequest": {
"id": "ChannelHangupRequest",
"description": "A hangup was requested on the channel.",
"properties": {
"cause": {
"type": "integer",
"description": "Integer representation of the cause of the hangup."
},
"soft": {
"type": "boolean",
"description": "Whether the hangup request was a soft hangup request."
},
"channel": {
"required": true,
"type": "Channel",
"description": "The channel on which the hangup was requested."
}
}
},
"ChannelVarset": {
"id": "ChannelVarset",
"description": "Channel variable changed.",
"properties": {
"variable": {
"required": true,
"type": "string",
"description": "The variable that changed."
},
"value": {
"required": true,
"type": "string",
"description": "The new value of the variable."
},
"channel": {
"required": true,
"type": "Channel",
"description": "The channel on which the variable was set."
}
}
},
"StasisEnd": {
"id": "StasisEnd",
"description": "Notification that a channel has left a Stasis appliction.",
"properties": {
"channel": {
"required": true,
"type": "Channel"
}
}
},
"StasisStart": {
"id": "StasisStart",
"description": "Notification that a channel has entered a Stasis appliction.",
"properties": {
"args": {
"required": true,
"type": "List[string]",
"description": "Arguments to the application"
},
"channel": {
"required": true,
"type": "Channel"
}
}
}
}
}
|
