Wiki source code of Extensions

Last modified by michaely on 2021/09/10 23:34
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 {{/layout-cell}}
20
21 {{layout-cell}}
22 {{panel title="On this page:"}}
23
24
25 {{toc maxLevel="2" indent="1"/}}
26 {{/panel}}
27 {{/layout-cell}}
28 {{/layout-section}}
29
30 {{layout-section ac:type="single"}}
31 {{layout-cell}}
32 (% style="color: rgb(0,0,0);" %)
33
34
35 = (% style="color: rgb(0,0,0);" %)JSON Representation(%%) =
36
37 {{code}}
38 {
39 "id": "e640205f-bc76-4db4-8e03-bf34eb33a8ce",
40 "extensionNumber": "4224",
41 "displayName": "Michael Y",
42 "configurationId": "813936dd-98a4-4ccc-8bcf-dd1f27673c1f",
43 "permissionId": "813936dd-98a4-4ccc-8bcf-dd1f27673c1f"
44 }
45 {{/code}}
46
47 (% style="line-height: 1.4285715;" %)
48 |=(((
49 Property
50 )))|=(((
51 Type
52 )))|=(((
53 Description
54 )))
55 |(((
56 {{{id}}}
57 )))|(((
58 String
59 )))|(((
60 The id of the extension.
61 )))
62 |(% colspan="1" %)(% colspan="1" %)
63 (((
64 extensionNumber
65 )))|(% colspan="1" %)(% colspan="1" %)
66 (((
67 String
68 )))|(% colspan="1" %)(% colspan="1" %)
69 (((
70 The number used to call the extension.
71 )))
72 |(% colspan="1" %)(% colspan="1" %)
73 (((
74 displayName
75 )))|(% colspan="1" %)(% colspan="1" %)
76 (((
77 String
78 )))|(% colspan="1" %)(% colspan="1" %)
79 (((
80 The display name of the extension.
81 )))
82 |(% colspan="1" %)(% colspan="1" %)
83 (((
84 {{{configurationId}}}
85 )))|(% colspan="1" %)(% colspan="1" %)
86 (((
87 String
88 )))|(% colspan="1" %)(% colspan="1" %)
89 (((
90 The id of the configuration object that represents the extension.
91 )))
92 |(% colspan="1" %)(% colspan="1" %)
93 (((
94 {{{permissionId}}}
95 )))|(% colspan="1" %)(% colspan="1" %)
96 (((
97 String
98 )))|(% colspan="1" %)(% colspan="1" %)
99 (((
100 The extension's permission id.
101 )))
102
103 = Root Resource Paths =
104
105 Paths used to access sets of the resource, in relation to parent resources.
106
107 |=(% colspan="2" %)(% colspan="2" %)
108 (((
109 {{{communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/extensions}}}
110 )))
111 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
112 (((
113 **Description**
114 )))|(((
115 Provides access to all extensions in a specified core server.
116
117 {{info}}
118 Excludes any extensions that are not bound to a licensed/full user.
119 {{/info}}
120
121 **Parameters:**
122
123 * core_server_id: the id of the parent core server\\
124 * core_server_slug: the slug of the parent core server
125
126 **Errors:**
127
128 * 404 Not Found: Returned if no core server with the given id or slug exists
129 )))
130 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
131 (((
132 **GET**
133 )))|(% colspan="1" %)(% colspan="1" %)
134 (((
135 Gets all extensions in the specified core server.
136 )))
137 |(% colspan="1" %)(% colspan="1" %)
138 (((
139
140 )))|(% colspan="1" %)(% colspan="1" %)
141 (((
142
143 )))
144 |=(% colspan="2" %)(% colspan="2" %)
145 (((
146 {{{communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/user/[{user_id} | getByName/{username}]/extensions}}}
147 )))
148 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
149 (((
150 **Description**
151 )))|(% colspan="1" %)(% colspan="1" %)
152 (((
153 Provides access to all the extensions bound to the specified user.
154
155 {{info}}
156 Excludes any extensions that are not bound to a licensed/full user.
157 {{/info}}
158
159 **Parameters:**
160
161 * core_server_id: the id of the parent core server\\
162 * core_server_slug: the slug of the parent core server
163 * user_id: the id of the parent user
164 * username: the username of the parent user
165
166 **Errors:**
167
168 * 404 Not Found: Returned if no core server with the given id or slug exists
169 * 404 Not Found: Returned if no user with the given id or username exists
170 )))
171 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
172 (((
173 **GET**
174 )))|(% colspan="1" %)(% colspan="1" %)
175 (((
176 Gets all extensions bound to the specified extension.
177 )))
178
179 = Instance Resource Paths =
180
181 Paths used to access a specific instance of the resource.
182
183 |=(% colspan="2" %)(% colspan="2" %)
184 (((
185 {{{{root_resource_path}/{extension_id}}}}
186 )))
187 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
188 (((
189 **Description**
190 )))|(% colspan="1" %)(% colspan="1" %)
191 (((
192 Provides access to a specific extension, by extension id.
193
194 {{info}}
195 This resource will not be available if the extension is not bound to a licensed/full user.
196 {{/info}}
197
198 **Parameters:**
199
200 * root_resource_path: One of the root resource paths for this resource. See Root Resource Paths above
201 * extension_id: the id of the extension to access
202
203 **Errors:**
204
205 * 404 Not Found: Returned if any of the ancestors in the root resource path could not be found
206 * 404 Not Found: Returned if no extension with the specified extension id could be found
207 * 403 Forbidden: Returned if any of the parents specified in the root resource path are restricted
208 * 403 Forbidden: Returned if the extension is not bound to a licensed/full user
209 )))
210 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
211 (((
212 **GET**
213 )))|(% colspan="1" %)(% colspan="1" %)
214 (((
215 Gets the specified extension.
216 )))
217 |(% colspan="2" %)(% colspan="2" %)
218 (((
219
220 )))
221 |=(% colspan="2" %)(% colspan="2" %)
222 (((
223 {{{{root_resource_path}/getByName/{extension_number}}}}
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 Provides access to a specific extension, by extension number.
231
232 {{info}}
233 This resource will not be available if the extension is not bound to a licensed/full user.
234 {{/info}}
235
236 **Parameters:**
237
238 * root_resource_path: One of the root resource paths for this resource. See Root Resource Paths above
239 * extension_number: the extension number of the extension to access
240
241 **Errors:**
242
243 * 404 Not Found: Returned if any of the ancestors in the root resource path could not be found
244 * 404 Not Found: Returned if no extension with the specified extension number could be found
245 * 403 Forbidden: Returned if any of the parents specified in the root resource path are restricted
246 * 403 Forbidden: Returned if if the extension is not bound to a licensed/full user
247 )))
248 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
249 (((
250 **GET**
251 )))|(% colspan="1" %)(% colspan="1" %)
252 (((
253 Gets the specified extension.
254 )))
255 |(% colspan="2" %)(% colspan="2" %)
256 (((
257
258 )))
259 |=(% colspan="2" %)(% colspan="2" %)
260 (((
261 {{{communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/queues/[{queue_id | getByName{queue_identifier}}]/agent/{agent_id}/extension}}}
262 )))
263 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
264 (((
265 **Description**
266 )))|(% colspan="1" %)(% colspan="1" %)
267 (((
268 Provides access to the extension the specified agent relates to.
269
270 {{info}}
271 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.
272 {{/info}}
273
274 **Parameters:**
275
276 * core_server_id: the id of the parent core server\\
277 * core_server_slug: the slug of the parent core server
278 * queue_id: the id of the parent queue
279 * queue_identifier: the identifier of the parent queue
280 * agent_id: the id of the agent
281
282 **Errors:**
283
284 * 404 Not Found: Returned if no core server with the given id or slug exists
285 * 404 Not Found: Returned if no queue with the given id or identifier exists
286 * 404 Not Found: Returned if no agent with the given id exists
287 * 403 Forbidden: Returned if the parent queue is not enabled
288 * 403 Forbidden: Returned if the agent is not related to an extension that is bound to a full user
289 )))
290 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
291 (((
292 **GET**
293 )))|(% colspan="1" %)(% colspan="1" %)
294 (((
295 Gets the extension the specified agent relates to.
296 )))
297
298 = Sub Resource Paths =
299
300 Paths used to access the child resources of this resource.
301
302 |=(% colspan="2" %)(% colspan="2" %)
303 (((
304 {{{{instance_resource_path}/agents}}}
305 )))
306 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
307 (((
308 **Description**
309 )))|(% colspan="1" %)(% colspan="1" %)
310 (((
311 Provides access to the agents related to the specified extension. See [[doc:Agents]].
312
313 {{info}}
314 This resource will not be available if the extension is not bound to a licensed/full user.
315
316 Excludes any agents that are not in an enabled queue.
317 {{/info}}
318
319 **Parameters:**
320
321 * instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above
322
323 **Errors:**
324
325 * 404 Not Found: Returned if any of the ancestors in the instance resource path could not be found
326 * 403 Forbidden: Returned if if the extension is not bound to a licensed/full user
327 )))
328 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
329 (((
330 **GET**
331 )))|(% colspan="1" %)(% colspan="1" %)
332 (((
333 Gets all the agents related to the specified extension.
334 )))
335 |(% colspan="1" %)(% colspan="1" %)
336 (((
337
338 )))|(% colspan="1" %)(% colspan="1" %)
339 (((
340
341 )))
342 |=(% colspan="2" %)(% colspan="2" %)
343 (((
344 {{{{instance_resource_path}/callSegments}}}
345 )))
346 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
347 (((
348 **Description**
349 )))|(% colspan="1" %)(% colspan="1" %)
350 (((
351 Provides access to the call segments for the specified extension. See [[doc:Call Segments]].
352
353 {{info}}
354 This resource will not be available if the extension is not bound to a licensed/full user.
355 {{/info}}
356
357 **Parameters:**
358
359 * instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above
360
361 **Errors:**
362
363 * 404 Not Found: Returned if any of the ancestors in the instance resource path could not be found
364 * 403 Forbidden: Returned if if the extension is not bound to a licensed/full user
365 )))
366 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
367 (((
368 **GET**
369 )))|(% colspan="1" %)(% colspan="1" %)
370 (((
371 Gets all the call segments for the specified extension.
372 )))
373
374 = Action Paths =
375
376 Actions that can be performed on this resource.
377
378 |=(% colspan="2" %)(% colspan="2" %)
379 (((
380 {{{{instance_resource_path}/originate}}}
381 )))
382 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
383 (((
384 **Description**
385 )))|(((
386 Originates a call from the specified extension.
387
388 {{info}}
389 This action will not be available if the extension is not bound to a licensed/full user.
390 {{/info}}
391
392 **Parameters:**
393
394 * instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above
395
396 **Errors:**
397
398 * 404 Not Found: Returned if any of the ancestors in the instance resource path could not be found
399 * 403 Forbidden: Returned if if the extension is not bound to a licensed/full user
400 * 422 Unprocessable Entity: Returned if no destination number value was provided
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}}

Search

Navigation

iSymphony