Skip to Content

Wiki source code of Extensions

Version 15.1 by michaely on 2015/07/10 12:45
Show last authors
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.2+**.
10 {{/info}}
11
12 {{note}}
13 This resource is restricted by licensing. See the resource and action path information below for more details.
14 {{/note}}
15
16 = (% style="color: rgb(0,0,0);" %)Description(%%) =
17
18 The live extension REST resource provides access to information about extensions in the system. This resource also provides actions for originating calls, and enabling/disabling Do Not Disturb on an extension.
19
20 \\
21 {{/layout-cell}}
22
23 {{layout-cell}}
24 {{panel title="On this page:"}}
25
26
27 {{toc maxLevel="2" indent="1"/}}
28 {{/panel}}
29 {{/layout-cell}}
30 {{/layout-section}}
31
32 {{layout-section ac:type="single"}}
33 {{layout-cell}}
34 (% style="color: rgb(0,0,0);" %)
35
36
37 = (% style="color: rgb(0,0,0);" %)JSON Representation(%%) =
38
39 {{code}}
40 {
41 "id": "e640205f-bc76-4db4-8e03-bf34eb33a8ce",
42 "extensionNumber": "4224",
43 "displayName": "Michael Y",
44 "configurationId": "813936dd-98a4-4ccc-8bcf-dd1f27673c1f",
45 "permissionId": "813936dd-98a4-4ccc-8bcf-dd1f27673c1f"
46 }
47 {{/code}}
48
49 (% style="line-height: 1.4285715;" %)
50 |=(((
51 Property
52 )))|=(((
53 Type
54 )))|=(((
55 Description
56 )))
57 |(((
58 {{{id}}}
59 )))|(((
60 String
61 )))|(((
62 The id of the extension.
63 )))
64 |(% colspan="1" %)(% colspan="1" %)
65 (((
66 extensionNumber
67 )))|(% colspan="1" %)(% colspan="1" %)
68 (((
69 String
70 )))|(% colspan="1" %)(% colspan="1" %)
71 (((
72 The number used to call the extension.
73 )))
74 |(% colspan="1" %)(% colspan="1" %)
75 (((
76 displayName
77 )))|(% colspan="1" %)(% colspan="1" %)
78 (((
79 String
80 )))|(% colspan="1" %)(% colspan="1" %)
81 (((
82 The display name of the extension.
83 )))
84 |(% colspan="1" %)(% colspan="1" %)
85 (((
86 {{{configurationId}}}
87 )))|(% colspan="1" %)(% colspan="1" %)
88 (((
89 String
90 )))|(% colspan="1" %)(% colspan="1" %)
91 (((
92 The id of the configuration object that represents the extension.
93 )))
94 |(% colspan="1" %)(% colspan="1" %)
95 (((
96 {{{permissionId}}}
97 )))|(% colspan="1" %)(% colspan="1" %)
98 (((
99 String
100 )))|(% colspan="1" %)(% colspan="1" %)
101 (((
102 The extension's permission id.
103 )))
104
105 = Root Resource Paths =
106
107 Paths used to access sets of the resource, in relation to parent resources.
108
109 |=(% colspan="2" %)(% colspan="2" %)
110 (((
111 {{{communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/extensions}}}
112 )))
113 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
114 (((
115 **Description**
116 )))|(((
117 Provides access to all extensions in a specified core server.
118
119 {{info}}
120 Excludes any extensions that are not bound to a licensed/full user.
121 {{/info}}
122
123 **Parameters:**
124
125 * core_server_id: the id of the parent core server\\
126 * core_server_slug: the slug of the parent core server
127
128 **Errors:**
129
130 * 404 Not Found: Returned if no core server with the given id or slug exists
131 )))
132 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
133 (((
134 **GET**
135 )))|(% colspan="1" %)(% colspan="1" %)
136 (((
137 Gets all extensions in the specified core server.
138 )))
139 |(% colspan="1" %)(% colspan="1" %)
140 (((
141
142 )))|(% colspan="1" %)(% colspan="1" %)
143 (((
144
145 )))
146 |=(% colspan="2" %)(% colspan="2" %)
147 (((
148 {{{communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/user/[{user_id} | getByName/{username}]/extensions}}}
149 )))
150 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
151 (((
152 **Description**
153 )))|(% colspan="1" %)(% colspan="1" %)
154 (((
155 Provides access to all the extensions bound to the specified user.
156
157 {{info}}
158 Excludes any extensions that are not bound to a licensed/full user.
159 {{/info}}
160
161 **Parameters:**
162
163 * core_server_id: the id of the parent core server\\
164 * core_server_slug: the slug of the parent core server
165 * user_id: the id of the parent user
166 * username: the username of the parent user
167
168 **Errors:**
169
170 * 404 Not Found: Returned if no core server with the given id or slug exists
171 * 404 Not Found: Returned if no user with the given id or username exists
172 )))
173 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
174 (((
175 **GET**
176 )))|(% colspan="1" %)(% colspan="1" %)
177 (((
178 Gets all extensions bound to the specified extension.
179 )))
180
181 = Instance Resource Paths =
182
183 Paths used to access a specific instance of the resource.
184
185 |=(% colspan="2" %)(% colspan="2" %)
186 (((
187 {{{{root_resource_path}/{extension_id}}}}
188 )))
189 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
190 (((
191 **Description**
192 )))|(% colspan="1" %)(% colspan="1" %)
193 (((
194 Provides access to a specific extension, by extension id.
195
196 {{info}}
197 This resource will not be available if the extension is not bound to a licensed/full user.
198 {{/info}}
199
200 **Parameters:**
201
202 * root_resource_path: One of the root resource paths for this resource. See Root Resource Paths above
203 * extension_id: the id of the extension to access
204
205 **Errors:**
206
207 * 404 Not Found: Returned if any of the ancestors in the root resource path could not be found
208 * 404 Not Found: Returned if no extension with the specified extension id could be found
209 * 403 Forbidden: Returned if any of the parents specified in the root resource path are restricted
210 * 403 Forbidden: Returned if the extension is not bound to a licensed/full user
211 )))
212 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
213 (((
214 **GET**
215 )))|(% colspan="1" %)(% colspan="1" %)
216 (((
217 Gets the specified extension.
218 )))
219 |(% colspan="2" %)(% colspan="2" %)
220 (((
221
222 )))
223 |=(% colspan="2" %)(% colspan="2" %)
224 (((
225 {{{{root_resource_path}/getByName/{extension_number}}}}
226 )))
227 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
228 (((
229 **Description**
230 )))|(% colspan="1" %)(% colspan="1" %)
231 (((
232 Provides access to a specific extension, by extension number.
233
234 {{info}}
235 This resource will not be available if the extension is not bound to a licensed/full user.
236 {{/info}}
237
238 **Parameters:**
239
240 * root_resource_path: One of the root resource paths for this resource. See Root Resource Paths above
241 * extension_number: the extension number of the extension to access
242
243 **Errors:**
244
245 * 404 Not Found: Returned if any of the ancestors in the root resource path could not be found
246 * 404 Not Found: Returned if no extension with the specified extension number could be found
247 * 403 Forbidden: Returned if any of the parents specified in the root resource path are restricted
248 * 403 Forbidden: Returned if if the extension is not bound to a licensed/full user
249 )))
250 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
251 (((
252 **GET**
253 )))|(% colspan="1" %)(% colspan="1" %)
254 (((
255 Gets the specified extension.
256 )))
257 |(% colspan="2" %)(% colspan="2" %)
258 (((
259
260 )))
261 |=(% colspan="2" %)(% colspan="2" %)
262 (((
263 {{{communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/queues/[{queue_id | getByName{queue_identifier}}]/agent/{agent_id}/extension}}}
264 )))
265 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
266 (((
267 **Description**
268 )))|(% colspan="1" %)(% colspan="1" %)
269 (((
270 Provides access to the extension the specified agent relates to.
271
272 {{info}}
273 This resource will not be available if the extension is not bound to a licensed/full user, or the agent is not in an enabled queue.
274 {{/info}}
275
276 **Parameters:**
277
278 * core_server_id: the id of the parent core server\\
279 * core_server_slug: the slug of the parent core server
280 * queue_id: the id of the parent queue
281 * queue_identifier: the identifier of the parent queue
282 * agent_id: the id of the agent
283
284 **Errors:**
285
286 * 404 Not Found: Returned if no core server with the given id or slug exists
287 * 404 Not Found: Returned if no queue with the given id or identifier exists
288 * 404 Not Found: Returned if no agent with the given id exists
289 * 403 Forbidden: Returned if the parent queue is not enabled or the agent is not related to an extension that is bound to a full user
290 )))
291 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
292 (((
293 **GET**
294 )))|(% colspan="1" %)(% colspan="1" %)
295 (((
296 Gets the extension the specified agent relates to.
297 )))
298
299 = Sub Resource Paths =
300
301 Paths used to access the child resources of this resource.
302
303 |=(% colspan="2" %)(% colspan="2" %)
304 (((
305 {{{{instance_resource_path}/agents}}}
306 )))
307 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
308 (((
309 **Description**
310 )))|(% colspan="1" %)(% colspan="1" %)
311 (((
312 Provides access to the agents related to the specified extension. See Agents.
313
314 {{info}}
315 This resource will not be available if the extension is not bound to a licensed/full user.
316
317 Excludes any agents that are not in an enabled queue.
318 {{/info}}
319
320 **Parameters:**
321
322 * instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above
323
324 **Errors:**
325
326 * 404 Not Found: Returned if any of the ancestors in the instance resource path could not be found
327 * 403 Forbidden: Returned if if the extension is not bound to a licensed/full user
328 )))
329 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
330 (((
331 **GET**
332 )))|(% colspan="1" %)(% colspan="1" %)
333 (((
334 Gets all the agents related to the specified extension.
335 )))
336 |(% colspan="1" %)(% colspan="1" %)
337 (((
338
339 )))|(% colspan="1" %)(% colspan="1" %)
340 (((
341
342 )))
343 |=(% colspan="2" %)(% colspan="2" %)
344 (((
345 {{{{instance_resource_path}/callSegments}}}
346 )))
347 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
348 (((
349 **Description**
350 )))|(% colspan="1" %)(% colspan="1" %)
351 (((
352 Provides access to the call segments for the specified extension. See Call Segments.
353
354 {{info}}
355 This resource will not be available if the extension is not bound to a licensed/full user.
356 {{/info}}
357
358 **Parameters:**
359
360 * instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above
361
362 **Errors:**
363
364 * 404 Not Found: Returned if any of the ancestors in the instance resource path could not be found
365 * 403 Forbidden: Returned if if the extension is not bound to a licensed/full user
366 )))
367 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
368 (((
369 **GET**
370 )))|(% colspan="1" %)(% colspan="1" %)
371 (((
372 Gets all the call segments for the specified extension.
373 )))
374
375 = Action Paths =
376
377 Actions that can be performed on this resource.
378
379 |=(% colspan="2" %)(% colspan="2" %)
380 (((
381 {{{{instance_resource_path}/originate}}}
382 )))
383 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
384 (((
385 **Description**
386 )))|(((
387 Originates a call from the specified extension.
388
389 {{info}}
390 This action will not be available if the extension is not bound to a licensed/full user.
391 {{/info}}
392
393 **Parameters:**
394
395 * instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above
396
397 **Errors:**
398
399 * 404 Not Found: Returned if any of the ancestors in the instance resource path could not be found
400 * 403 Forbidden: Returned if if the extension is not bound to a licensed/full user
401 )))
402 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
403 (((
404 **JSON**
405 )))|(% colspan="1" %)(% colspan="1" %)
406 (((
407 {{code}}
408 {
409 "destinationNumber": "18005555555"
410 }
411 {{/code}}
412
413 **Properties:**
414
415 |=(((
416 Property
417 )))|=(((
418 Type
419 )))|=(((
420 Description
421 )))
422 |(% colspan="1" %)(% colspan="1" %)
423 (((
424 {{{destinationNumber}}}
425 )))|(% colspan="1" %)(% colspan="1" %)
426 (((
427 String
428 )))|(% colspan="1" %)(% colspan="1" %)
429 (((
430 The number to originate to.
431 )))
432
433 **
434 **
435 )))
436 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
437 (((
438 **POST
439 **
440 )))|(% colspan="1" %)(% colspan="1" %)
441 (((
442 Originates a call from the specified extension to a destination number.
443 )))
444 |(% colspan="2" %)(% colspan="2" %)
445 (((
446
447 )))
448 |=(% colspan="2" %)(% colspan="2" %)
449 (((
450 {{{{instance_resource_path}/enableDnd}}}
451 )))
452 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
453 (((
454 **Description**
455 )))|(% colspan="1" %)(% colspan="1" %)
456 (((
457 Enables do not disturb on the specified extension.
458
459 {{info}}
460 This action will not be available if the extension is not bound to a licensed/full user.
461 {{/info}}
462
463 **Parameters:**
464
465 * instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above
466
467 **Errors:**
468
469 * 404 Not Found: Returned if any of the ancestors in the instance resource path could not be found
470 * 403 Forbidden: Returned if if the extension is not bound to a licensed/full user
471 )))
472 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
473 (((
474 **POST
475 **
476 )))|(% colspan="1" %)(% colspan="1" %)
477 (((
478 Enables do not disturb on the specified extension.
479 )))
480 |(% colspan="2" %)(% colspan="2" %)
481 (((
482
483 )))
484 |=(% colspan="2" %)(% colspan="2" %)
485 (((
486 {{{{instance_resource_path}/disableDnd}}}
487 )))
488 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
489 (((
490 **Description**
491 )))|(% colspan="1" %)(% colspan="1" %)
492 (((
493 Disables do not disturb on the specified extension.
494
495 {{info}}
496 This action will not be available if the extension is not bound to a licensed/full user.
497 {{/info}}
498
499 **Parameters:**
500
501 * instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above
502
503 **Errors:**
504
505 * 404 Not Found: Returned if any of the ancestors in the instance resource path could not be found
506 * 403 Forbidden: Returned if if the extension is not bound to a licensed/full user
507 )))
508 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
509 (((
510 **POST
511 **
512 )))|(% colspan="1" %)(% colspan="1" %)
513 (((
514 Disables do not disturb on the specified extension.
515 )))
516
517 = Curl Examples =
518
519 === Get all extensions in a core server ===
520
521 {{code language="bash"}}
522 curl --user manager:manag3rpa55word -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4/extensions
523 {{/code}}
524
525 === (% style="color: rgb(0,0,0);" %)Get a specific extension in a core server(%%) ===
526
527 {{code language="bash"}}
528 curl --user manager:manag3rpa55word -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4/extensions/ef2faba9-8557-49c1-9ffc-5a71f41c7a23
529 {{/code}}
530
531 === (% style="color: rgb(0,0,0);" %)Get all extensions bound to a user(%%) ===
532
533 {{code language="bash"}}
534 curl --user manager:manag3rpa55word -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4/users/ce1b2b59-15ad-46d2-a96a-2b4099630438/extensions
535 {{/code}}
536
537 === (% style="color: rgb(0,0,0);" %)Get a specific extension bound to a user(%%) ===
538
539 {{code language="bash"}}
540 curl --user manager:manag3rpa55word -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4/users/ce1b2b59-15ad-46d2-a96a-2b4099630438/extensions/ef2faba9-8557-49c1-9ffc-5a71f41c7a23
541 {{/code}}
542
543 === (% style="color: rgb(0,0,0);" %)Get the extension related to a specific queue agent(%%) ===
544
545 {{code language="bash"}}
546 curl --user manager:manag3rpa55word -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4/queues/05bf3ecf-ce6b-4c8f-9aa6-f8d111b2699b/agents/d5e41ab4-445a-4613-99b5-7f5343045220/extension
547 {{/code}}
548
549 === Originate a call from a specific extension to a given number ===
550
551 {{code language="bash"}}
552 curl --user manager:manag3rpa55word -i -H "Content-Type: application/json" -X POST -d '{"destinationNumber": "18005555555"}' http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4/extensions/ef2faba9-8557-49c1-9ffc-5a71f41c7a23/originate
553 {{/code}}
554
555 === (% style="color: rgb(0,0,0);" %)Enable DND on a specific extension(%%) ===
556
557 {{code language="bash"}}
558 curl --user manager:manag3rpa55word -i -X POST http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4/extensions/ef2faba9-8557-49c1-9ffc-5a71f41c7a23/enableDnd
559 {{/code}}
560
561 === Disable DND on a specific extension ===
562
563 {{code language="bash"}}
564 curl --user manager:manag3rpa55word -i -X POST http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4/extensions/ef2faba9-8557-49c1-9ffc-5a71f41c7a23/disableDnd
565 {{/code}}
566 {{/layout-cell}}
567 {{/layout-section}}
568 {{/layout}}