Wiki source code of Asterisk Core Server Configuration
Last modified by michaely on 2021/09/10 23:34
Show last authors
author | version | line-number | content |
---|---|---|---|
1 | {{layout}} | ||
2 | {{layout-section ac:type="two_right_sidebar"}} | ||
3 | {{layout-cell}} | ||
4 | {{warning}} | ||
5 | This page is currently being written. Although the information below is probably accurate, it may not be complete or may have errors. | ||
6 | {{/warning}} | ||
7 | |||
8 | {{info}} | ||
9 | The information on this page applies to **iSymphony 3.1+**. | ||
10 | {{/info}} | ||
11 | |||
12 | = (% style="color: rgb(0,0,0);" %)Description(%%) = | ||
13 | |||
14 | The Asterisk core server configuration REST resource allows access to the top level Asterisk specific configuration for a core server. This resource allows modification of the top level Asterisk configuration for a core server. | ||
15 | |||
16 | |||
17 | {{/layout-cell}} | ||
18 | |||
19 | {{layout-cell}} | ||
20 | {{panel title="On this page:"}} | ||
21 | |||
22 | |||
23 | {{toc maxLevel="2" indent="1"/}} | ||
24 | {{/panel}} | ||
25 | {{/layout-cell}} | ||
26 | {{/layout-section}} | ||
27 | |||
28 | {{layout-section ac:type="single"}} | ||
29 | {{layout-cell}} | ||
30 | = (% style="color: rgb(0,0,0);" %)Root Resource Path(%%) = | ||
31 | |||
32 | {{code}} | ||
33 | communication_manager/rest/config/asterisk | ||
34 | {{/code}} | ||
35 | |||
36 | = JSON Representation = | ||
37 | |||
38 | {{code}} | ||
39 | { | ||
40 | "id": "ff2e69f0-01eb-43b0-a8cd-de47e0674229", | ||
41 | "serverId": "fe205631-d5f8-4e88-9698-0e5a645e6bca", | ||
42 | "tenantId": "", | ||
43 | "ringStatusEnabled": true, | ||
44 | "pageStatusEnabled": true, | ||
45 | "confBridge": true, | ||
46 | "originatingContext": "from-internal", | ||
47 | "redirectingContext": "from-internal", | ||
48 | "musicOnHoldClass": "default", | ||
49 | "originateTimeout": 30000 | ||
50 | } | ||
51 | {{/code}} | ||
52 | |||
53 | |=((( | ||
54 | Property | ||
55 | )))|=((( | ||
56 | Type | ||
57 | )))|=((( | ||
58 | Description | ||
59 | ))) | ||
60 | |((( | ||
61 | {{{id}}} | ||
62 | )))|((( | ||
63 | String | ||
64 | )))|((( | ||
65 | Configuration id of the top level Asterisk configuration object. | ||
66 | ))) | ||
67 | |(% colspan="1" %)(% colspan="1" %) | ||
68 | ((( | ||
69 | serverId | ||
70 | )))|(% colspan="1" %)(% colspan="1" %) | ||
71 | ((( | ||
72 | String | ||
73 | )))|(% colspan="1" %)(% colspan="1" %) | ||
74 | ((( | ||
75 | The core server id the Asterisk configuration is for. | ||
76 | ))) | ||
77 | |(% colspan="1" %)(% colspan="1" %) | ||
78 | ((( | ||
79 | tenantId | ||
80 | )))|(% colspan="1" %)(% colspan="1" %) | ||
81 | ((( | ||
82 | String | ||
83 | )))|(% colspan="1" %)(% colspan="1" %) | ||
84 | ((( | ||
85 | The tenant id of the core server. | ||
86 | ))) | ||
87 | |(% colspan="1" %)(% colspan="1" %) | ||
88 | ((( | ||
89 | ringStatusEnabled | ||
90 | )))|(% colspan="1" %)(% colspan="1" %) | ||
91 | ((( | ||
92 | Boolean | ||
93 | )))|(% colspan="1" %)(% colspan="1" %) | ||
94 | ((( | ||
95 | Flag specifying if ringing status should be shown or not. Not currently used. | ||
96 | ))) | ||
97 | |(% colspan="1" %)(% colspan="1" %) | ||
98 | ((( | ||
99 | {{{pageStatusEnabled}}} | ||
100 | )))|(% colspan="1" %)(% colspan="1" %) | ||
101 | ((( | ||
102 | Boolean | ||
103 | )))|(% colspan="1" %)(% colspan="1" %) | ||
104 | ((( | ||
105 | Flag specifying if page status should be shown or not. Not currently used. | ||
106 | ))) | ||
107 | |(% colspan="1" %)(% colspan="1" %) | ||
108 | ((( | ||
109 | confBridge | ||
110 | )))|(% colspan="1" %)(% colspan="1" %) | ||
111 | ((( | ||
112 | Boolean | ||
113 | )))|(% colspan="1" %)(% colspan="1" %) | ||
114 | ((( | ||
115 | Flag specifying if app_confbridge is used for dynamic conferences or not. | ||
116 | ))) | ||
117 | |(% colspan="1" %)(% colspan="1" %) | ||
118 | ((( | ||
119 | {{{originatingContext}}} | ||
120 | )))|(% colspan="1" %)(% colspan="1" %) | ||
121 | ((( | ||
122 | String | ||
123 | )))|(% colspan="1" %)(% colspan="1" %) | ||
124 | ((( | ||
125 | Entry point dialplan context for all call originations made in the panel. | ||
126 | ))) | ||
127 | |(% colspan="1" %)(% colspan="1" %) | ||
128 | ((( | ||
129 | {{{redirectingContext}}} | ||
130 | )))|(% colspan="1" %)(% colspan="1" %) | ||
131 | ((( | ||
132 | String | ||
133 | )))|(% colspan="1" %)(% colspan="1" %) | ||
134 | ((( | ||
135 | Entry point dialplan context for all call transfers made in the panel. | ||
136 | ))) | ||
137 | |(% colspan="1" %)(% colspan="1" %) | ||
138 | ((( | ||
139 | {{{musicOnHoldClass}}} | ||
140 | )))|(% colspan="1" %)(% colspan="1" %) | ||
141 | ((( | ||
142 | String | ||
143 | )))|(% colspan="1" %)(% colspan="1" %) | ||
144 | ((( | ||
145 | Music on hold class used when placing calls on hold in the panel. | ||
146 | ))) | ||
147 | |(% colspan="1" %)(% colspan="1" %) | ||
148 | ((( | ||
149 | {{{originateTimeout}}} | ||
150 | )))|(% colspan="1" %)(% colspan="1" %) | ||
151 | ((( | ||
152 | String | ||
153 | )))|(% colspan="1" %)(% colspan="1" %) | ||
154 | ((( | ||
155 | Number of milliseconds to ring the origination extension when making a new call in the panel, before timing out. | ||
156 | ))) | ||
157 | |||
158 | = Resource Paths = | ||
159 | |||
160 | |=(% colspan="2" %)(% colspan="2" %) | ||
161 | ((( | ||
162 | {{{communication_manager/rest/config/asterisk}}} | ||
163 | ))) | ||
164 | |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %) | ||
165 | ((( | ||
166 | **Description** | ||
167 | )))|((( | ||
168 | Accesses the top level Asterisk configuration for all core servers. | ||
169 | ))) | ||
170 | |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %) | ||
171 | ((( | ||
172 | **GET** | ||
173 | )))|((( | ||
174 | Gets the top level Asterisk configuration for all core servers. | ||
175 | ))) | ||
176 | |(% colspan="2" %)(% colspan="2" %) | ||
177 | ((( | ||
178 | |||
179 | ))) | ||
180 | |=(% colspan="2" %)(% colspan="2" %) | ||
181 | ((( | ||
182 | {{{communication_manager/rest/config/asterisk/{coreServerId}}}} | ||
183 | ))) | ||
184 | |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %) | ||
185 | ((( | ||
186 | **Description** | ||
187 | )))|((( | ||
188 | Accesses the top level Asterisk configuration for a specific core server. | ||
189 | |||
190 | **Parameters:** | ||
191 | |||
192 | * coreServerId: The core server id. | ||
193 | ))) | ||
194 | |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %) | ||
195 | ((( | ||
196 | **GET** | ||
197 | )))|((( | ||
198 | Gets the top level Asterisk configuration for a specific core server. | ||
199 | |||
200 | **Errors:** | ||
201 | |||
202 | * 404 'Failed to locate the core server with the given id': Returned if no core server exists with the given id. | ||
203 | ))) | ||
204 | |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %) | ||
205 | ((( | ||
206 | **PUT** | ||
207 | )))|(% colspan="1" %)(% colspan="1" %) | ||
208 | ((( | ||
209 | Updates the top level Asterisk configuration. | ||
210 | |||
211 | **Errors:** | ||
212 | |||
213 | * 404 'Failed to locate the core server with the given id': Returned if no core server exists with the given id. | ||
214 | * 412 'No originatingContext provided.': Returned if no originating context was provided. | ||
215 | * 412 'No redirectingContext provided.': Returned if no redirecting context was provided. | ||
216 | * 412 'No musicOnHoldClass provided.': Returned if not music on hold class was provided. | ||
217 | ))) | ||
218 | |||
219 | = Sub/Child Resource Paths = | ||
220 | |||
221 | |=(% colspan="2" %)(% colspan="2" %) | ||
222 | ((( | ||
223 | {{{communication_manager/rest/config/asterisk/{coreServerId}/pbxServers}}} | ||
224 | ))) | ||
225 | |=(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %) | ||
226 | ((( | ||
227 | **Description** | ||
228 | )))|(% colspan="1" %)(% colspan="1" %) | ||
229 | ((( | ||
230 | Access the sub/child resource for the PBX server connections. | ||
231 | |||
232 | (% style="line-height: 1.42857;" %)**Parameters:** | ||
233 | |||
234 | * coreServerId: The id of the core server. | ||
235 | |||
236 | **Errors:** | ||
237 | |||
238 | * 404 'Failed to locate the core server with the given id': Returned if no core server exists with the given id. | ||
239 | |||
240 | See [[doc:Asterisk PBX Server Configuration]] for more information. | ||
241 | ))) | ||
242 | |(% colspan="2" %)(% colspan="2" %) | ||
243 | ((( | ||
244 | |||
245 | ))) | ||
246 | |=(% colspan="2" %)(% colspan="2" %) | ||
247 | ((( | ||
248 | {{{communication_manager/rest/config/asterisk/{coreServerId}/extensions}}} | ||
249 | ))) | ||
250 | |=(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %) | ||
251 | ((( | ||
252 | **Description** | ||
253 | )))|(% colspan="1" %)(% colspan="1" %) | ||
254 | ((( | ||
255 | Access the sub/child resource for extensions. | ||
256 | |||
257 | **Parameters:** | ||
258 | |||
259 | * coreServerId: The id of the core server. | ||
260 | |||
261 | **Errors:** | ||
262 | |||
263 | * 404 'Failed to locate the core server with the given id': Returned if no core server exists with the given id. | ||
264 | |||
265 | See [[doc:Asterisk Extension Configuration]] for more information. | ||
266 | ))) | ||
267 | |(% colspan="2" %)(% colspan="2" %) | ||
268 | ((( | ||
269 | |||
270 | ))) | ||
271 | |=(% colspan="2" %)(% colspan="2" %) | ||
272 | ((( | ||
273 | {{{communication_manager/rest/config/asterisk/{coreServerId}/queues}}} | ||
274 | ))) | ||
275 | |=(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %) | ||
276 | ((( | ||
277 | **Description** | ||
278 | )))|(% colspan="1" %)(% colspan="1" %) | ||
279 | ((( | ||
280 | Access the sub/child resource for queues. | ||
281 | |||
282 | **Parameters:** | ||
283 | |||
284 | * coreServerId: The id of the core server. | ||
285 | |||
286 | **Errors:** | ||
287 | |||
288 | * 404 'Failed to locate the core server with the given id': Returned if no core server exists with the given id. | ||
289 | |||
290 | See [[doc:Asterisk Queue Configuration]] for more information. | ||
291 | ))) | ||
292 | |(% colspan="2" %)(% colspan="2" %) | ||
293 | ((( | ||
294 | |||
295 | ))) | ||
296 | |=(% colspan="2" %)(% colspan="2" %) | ||
297 | ((( | ||
298 | {{{communication_manager/rest/config/asterisk/{coreServerId}/parkingLots}}} | ||
299 | ))) | ||
300 | |=(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %) | ||
301 | ((( | ||
302 | **Description** | ||
303 | )))|(% colspan="1" %)(% colspan="1" %) | ||
304 | ((( | ||
305 | Access the sub/child resource for parking lots. | ||
306 | |||
307 | **Parameters:** | ||
308 | |||
309 | * coreServerId: The id of the core server. | ||
310 | |||
311 | **Errors:** | ||
312 | |||
313 | * 404 'Failed to locate the core server with the given id': Returned if no core server exists with the given id. | ||
314 | |||
315 | See [[doc:Asterisk Parking Lot Configuration]] for more information. | ||
316 | ))) | ||
317 | |(% colspan="2" %)(% colspan="2" %) | ||
318 | ((( | ||
319 | |||
320 | ))) | ||
321 | |=(% colspan="2" %)(% colspan="2" %) | ||
322 | ((( | ||
323 | {{{communication_manager/rest/config/asterisk/{coreServerId}/conferenceRooms}}} | ||
324 | ))) | ||
325 | |=(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %) | ||
326 | ((( | ||
327 | **Description** | ||
328 | )))|(% colspan="1" %)(% colspan="1" %) | ||
329 | ((( | ||
330 | Access the sub/child resource for conference rooms. | ||
331 | |||
332 | **Parameters:** | ||
333 | |||
334 | * coreServerId: The id of the core server. | ||
335 | |||
336 | **Errors:** | ||
337 | |||
338 | * 404 'Failed to locate the core server with the given id': Returned if no core server exists with the given id. | ||
339 | |||
340 | See [[doc:Asterisk Conference Room Configuration]] for more information. | ||
341 | ))) | ||
342 | |(% colspan="2" %)(% colspan="2" %) | ||
343 | ((( | ||
344 | |||
345 | ))) | ||
346 | |=(% colspan="2" %)(% colspan="2" %) | ||
347 | ((( | ||
348 | {{{communication_manager/rest/config/asterisk/{coreServerId}/extensionGroups}}} | ||
349 | ))) | ||
350 | |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %) | ||
351 | ((( | ||
352 | **Description** | ||
353 | )))|((( | ||
354 | Access the sub/child resource for extension groups. | ||
355 | |||
356 | **Parameters:** | ||
357 | |||
358 | * coreServerId: The id of the core server. | ||
359 | |||
360 | **Errors:** | ||
361 | |||
362 | * 404 'Failed to locate the core server with the given id': Returned if no core server exists with the given id. | ||
363 | |||
364 | See [[doc:Asterisk Extension Group Configuration]] for more information. | ||
365 | ))) | ||
366 | |(% colspan="2" %)(% colspan="2" %) | ||
367 | ((( | ||
368 | |||
369 | ))) | ||
370 | |=(% colspan="2" %)(% colspan="2" %) | ||
371 | ((( | ||
372 | {{{communication_manager/rest/config/asterisk/{coreServerId}/voicemailAgentIdentifiers}}} | ||
373 | ))) | ||
374 | |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %) | ||
375 | ((( | ||
376 | **Description** | ||
377 | )))|(% colspan="1" %)(% colspan="1" %) | ||
378 | ((( | ||
379 | Access the sub/child resource for extension groups. | ||
380 | |||
381 | **Parameters:** | ||
382 | |||
383 | * coreServerId: The id of the core server. | ||
384 | |||
385 | **Errors:** | ||
386 | |||
387 | * 404 'Failed to locate the core server with the given id': Returned if no core server exists with the given id. | ||
388 | |||
389 | See [[Asterisk Core Server Voicemail Agent Configuration>>doc:Asterisk Core Server Voicemail Agent Configuration]] for more information. | ||
390 | ))) | ||
391 | |(% colspan="2" %)(% colspan="2" %) | ||
392 | ((( | ||
393 | |||
394 | ))) | ||
395 | |=(% colspan="2" %)(% colspan="2" %) | ||
396 | ((( | ||
397 | {{{communication_manager/rest/config/asterisk/voicemailAgents}}} | ||
398 | ))) | ||
399 | |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %) | ||
400 | ((( | ||
401 | **Description** | ||
402 | )))|(% colspan="1" %)(% colspan="1" %) | ||
403 | ((( | ||
404 | Access the sub/child resource for the voicemail agents connected to the system. | ||
405 | |||
406 | See [[doc:Asterisk Voicemail Agent Configuration]] for more information. | ||
407 | ))) | ||
408 | |(% colspan="2" %)(% colspan="2" %) | ||
409 | ((( | ||
410 | |||
411 | ))) | ||
412 | |=(% colspan="2" %)(% colspan="2" %) | ||
413 | ((( | ||
414 | {{{communication_manager/rest/config/asterisk/recordingAgents}}} | ||
415 | ))) | ||
416 | |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %) | ||
417 | ((( | ||
418 | **Description** | ||
419 | )))|(% colspan="1" %)(% colspan="1" %) | ||
420 | ((( | ||
421 | Access the sub/child resource for the recording agents connected to the system. | ||
422 | |||
423 | See [[doc:Asterisk Recording Agent Configuration]] for more information. | ||
424 | ))) | ||
425 | |||
426 | = Curl Examples = | ||
427 | |||
428 | === Get the top level Asterisk configuration for all core servers === | ||
429 | |||
430 | {{code language="bash"}} | ||
431 | curl --user manager:manag3rpa55word -k -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/config/asterisk | ||
432 | {{/code}} | ||
433 | |||
434 | === Get the top level Asterisk configuration for a specific core server === | ||
435 | |||
436 | {{code language="bash"}} | ||
437 | curl --user manager:manag3rpa55word -k -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/config/asterisk/56cf70a3-1ee0-4b09-8f40-297430eeeddf | ||
438 | {{/code}} | ||
439 | |||
440 | === Update the top level Asterisk configuration === | ||
441 | |||
442 | {{code language="bash"}} | ||
443 | curl --user manager:manag3rpa55word -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X PUT -d '{"id":"ff2e69f0-01eb-43b0-a8cd-de47e0674229","serverId":"56cf70a3-1ee0-4b09-8f40-297430eeeddf","tenantId":"","ringStatusEnabled":true,"pageStatusEnabled":true,"confBridge":true,"originatingContext":"from-internal","redirectingContext":"from-internal","musicOnHoldClass":"default","originateTimeout":30000}' http://localhost:58080/communication_manager/rest/config/asterisk/56cf70a3-1ee0-4b09-8f40-297430eeeddf | ||
444 | {{/code}} | ||
445 | {{/layout-cell}} | ||
446 | {{/layout-section}} | ||
447 | {{/layout}} |