Skip to Content

Wiki source code of Queues

Version 7.1 by michaely on 2015/07/10 16:50
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 queue REST resource provides access to information about queues in the system. This resource also provides actions to log extensions in and out of queues.
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": "4f302d40-bd94-4fdd-8129-cf53ed68cb5e",
40 "displayName": "IncomingQ",
41 "identifier": "5001",
42 "configurationId": "c46f4e60-aba2-4340-a6a5-0c7304d40ba1",
43 "permissionId": "c46f4e60-aba2-4340-a6a5-0c7304d40ba1"
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 queue.
61 )))
62 |(% colspan="1" %)(% colspan="1" %)
63 (((
64 displayName
65 )))|(% colspan="1" %)(% colspan="1" %)
66 (((
67 String
68 )))|(% colspan="1" %)(% colspan="1" %)
69 (((
70 The display name of the queue.
71 )))
72 |(% colspan="1" %)(% colspan="1" %)
73 (((
74 {{{identifier}}}
75 )))|(% colspan="1" %)(% colspan="1" %)
76 (((
77 String
78 )))|(% colspan="1" %)(% colspan="1" %)
79 (((
80 The identifier of the queue.
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 queue.
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 queue'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}]/queues}}}
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 queues in the specified core server.
116
117 {{info}}
118 Excludes any queues that are not enabled.
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 queues in the specified core server.
136 )))
137
138 = Instance Resource Paths =
139
140 Paths used to access a specific instance of the resource.
141
142 |=(% colspan="2" %)(% colspan="2" %)
143 (((
144 {{{{root_resource_path}/{queue_id}}}}
145 )))
146 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
147 (((
148 **Description**
149 )))|(% colspan="1" %)(% colspan="1" %)
150 (((
151 Provides access to a specific queue, by queue id.
152
153 {{info}}
154 This resource will not be available if the queue is not enabled.
155 {{/info}}
156
157 **Parameters:**
158
159 * root_resource_path: One of the root resource paths for this resource. See Root Resource Paths above
160 * queue_id: the id of the queue to access
161
162 **Errors:**
163
164 * 404 Not Found: Returned if any of the ancestors in the root resource path could not be found
165 * 404 Not Found: Returned if no queue with the specified queue id could be found
166 * 403 Forbidden: Returned if the specified queue is not enabled
167 )))
168 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
169 (((
170 **GET**
171 )))|(% colspan="1" %)(% colspan="1" %)
172 (((
173 Gets the specified queue.
174 )))
175 |(% colspan="2" %)(% colspan="2" %)
176 (((
177
178 )))
179 |=(% colspan="2" %)(% colspan="2" %)
180 (((
181 {{{{root_resource_path}/getByName/{queue_identifier}}}}
182 )))
183 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
184 (((
185 **Description**
186 )))|(% colspan="1" %)(% colspan="1" %)
187 (((
188 Provides access to a specific queue, by queue identifier.
189
190 {{info}}
191 This resource will not be available if the queue is not enabled.
192 {{/info}}
193
194 **Parameters:**
195
196 * root_resource_path: One of the root resource paths for this resource. See Root Resource Paths above
197 * queue_identifier: the identifier of the queue to access
198
199 **Errors:**
200
201 *
202 ** 404 Not Found: Returned if any of the ancestors in the root resource path could not be found
203 ** 404 Not Found: Returned if no queue with the specified queue identifier could be found
204 ** 403 Forbidden: Returned if the specified queue is not enabled
205 )))
206 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
207 (((
208 **GET**
209 )))|(% colspan="1" %)(% colspan="1" %)
210 (((
211 Gets the specified queue.
212 )))
213
214 = Sub Resource Paths =
215
216 Paths used to access the child resources of this resource.
217
218 |=(% colspan="2" %)(% colspan="2" %)
219 (((
220 {{{{instance_resource_path}/agents}}}
221 )))
222 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
223 (((
224 **Description**
225 )))|(% colspan="1" %)(% colspan="1" %)
226 (((
227 Provides access to all the agents logged into the specified queue. See Agents.
228
229 {{info}}
230 This resource will not be available if the queue is not enabled.
231
232 Excludes any agents that are not related to an extension that is bound to a licensed/full user.
233 {{/info}}
234
235 **Parameters:**
236
237 * instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above
238
239 **Errors:**
240
241 * 404 Not Found: Returned if any of the ancestors in the instance resource path could not be found
242 * 403 Forbidden: Returned if any of the parents specified in the root resource path are restricted
243 )))
244 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
245 (((
246 **GET**
247 )))|(% colspan="1" %)(% colspan="1" %)
248 (((
249 Gets all the agents logged into the specified queue.
250 )))
251 |(% colspan="1" %)(% colspan="1" %)
252 (((
253
254 )))|(% colspan="1" %)(% colspan="1" %)
255 (((
256
257 )))
258 |=(% colspan="2" %)(% colspan="2" %)
259 (((
260 {{{{instance_resource_path}/callSegments}}}
261 )))
262 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
263 (((
264 **Description**
265 )))|(% colspan="1" %)(% colspan="1" %)
266 (((
267 Provides access to the call segments waiting in the specified queue. See Call Segments.
268
269 {{info}}
270 This resource will not be available if the queue is not enabled.
271
272 Excludes any call segments that are not related to an extension that is bound to a licensed/full user, or have not been bound to another call segment that is related to an extension that is bound to a licensed/full user.
273 {{/info}}
274
275 **Parameters:**
276
277 * instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above
278
279 **Errors:**
280
281 *
282 ** 404 Not Found: Returned if any of the ancestors in the instance resource path could not be found
283 ** 403 Forbidden: Returned if any of the parents specified in the root resource path are restricted
284 )))
285 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
286 (((
287 **GET**
288 )))|(% colspan="1" %)(% colspan="1" %)
289 (((
290 Gets all the call segments waiting in the specified queue.
291 )))
292 |(% colspan="2" %)(% colspan="2" %)
293 (((
294
295 )))
296 |=(% colspan="2" %)(% colspan="2" %)
297 (((
298 {{{{instance_resource_path}/statistics}}}
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 Provides access to all statistics of the queue. See Statistics.
306
307 {{info}}
308 This resource will not be available if the queue is not enabled.
309 {{/info}}
310
311 **Parameters:**
312
313 * instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above
314
315 **Errors:**
316
317 *
318 ** 404 Not Found: Returned if any of the ancestors in the instance resource path could not be found
319 ** 403 Forbidden: Returned if any of the parents specified in the root resource path are restricted
320 )))
321 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
322 (((
323 **GET**
324 )))|(% colspan="1" %)(% colspan="1" %)
325 (((
326 Gets all statistics for the specified queue.
327 )))
328
329 = Action Paths =
330
331 Actions that can be performed on this resource.
332
333 |=(% colspan="2" %)(% colspan="2" %)
334 (((
335 {{{{instance_resource_path}/originate}}}
336 )))
337 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
338 (((
339 **Description**
340 )))|(((
341 Originates a call from the specified extension.
342
343 {{info}}
344 This action will not be available if the extension is not bound to a licensed/full user.
345 {{/info}}
346
347 **Parameters:**
348
349 * instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above
350
351 **Errors:**
352
353 * 404 Not Found: Returned if any of the ancestors in the instance resource path could not be found
354 * 403 Forbidden: Returned if if the extension is not bound to a licensed/full user
355 )))
356 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
357 (((
358 **JSON**
359 )))|(% colspan="1" %)(% colspan="1" %)
360 (((
361 {{code}}
362 {
363 "destinationNumber": "18005555555"
364 }
365 {{/code}}
366
367 **Properties:**
368
369 |=(((
370 Property
371 )))|=(((
372 Type
373 )))|=(((
374 Description
375 )))
376 |(% colspan="1" %)(% colspan="1" %)
377 (((
378 {{{destinationNumber}}}
379 )))|(% colspan="1" %)(% colspan="1" %)
380 (((
381 String
382 )))|(% colspan="1" %)(% colspan="1" %)
383 (((
384 The number to originate to.
385 )))
386
387 **
388 **
389 )))
390 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
391 (((
392 **POST
393 **
394 )))|(% colspan="1" %)(% colspan="1" %)
395 (((
396 Originates a call from the specified extension to a destination number.
397 )))
398 |(% colspan="2" %)(% colspan="2" %)
399 (((
400
401 )))
402 |=(% colspan="2" %)(% colspan="2" %)
403 (((
404 {{{{instance_resource_path}/enableDnd}}}
405 )))
406 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
407 (((
408 **Description**
409 )))|(% colspan="1" %)(% colspan="1" %)
410 (((
411 Enables do not disturb on the specified extension.
412
413 {{info}}
414 This action will not be available if the extension is not bound to a licensed/full user.
415 {{/info}}
416
417 **Parameters:**
418
419 * instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above
420
421 **Errors:**
422
423 * 404 Not Found: Returned if any of the ancestors in the instance resource path could not be found
424 * 403 Forbidden: Returned if if the extension is not bound to a licensed/full user
425 )))
426 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
427 (((
428 **POST
429 **
430 )))|(% colspan="1" %)(% colspan="1" %)
431 (((
432 Enables do not disturb on the specified extension.
433 )))
434 |(% colspan="2" %)(% colspan="2" %)
435 (((
436
437 )))
438 |=(% colspan="2" %)(% colspan="2" %)
439 (((
440 {{{{instance_resource_path}/disableDnd}}}
441 )))
442 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
443 (((
444 **Description**
445 )))|(% colspan="1" %)(% colspan="1" %)
446 (((
447 Disables do not disturb on the specified extension.
448
449 {{info}}
450 This action will not be available if the extension is not bound to a licensed/full user.
451 {{/info}}
452
453 **Parameters:**
454
455 * instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above
456
457 **Errors:**
458
459 * 404 Not Found: Returned if any of the ancestors in the instance resource path could not be found
460 * 403 Forbidden: Returned if if the extension is not bound to a licensed/full user
461 )))
462 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
463 (((
464 **POST
465 **
466 )))|(% colspan="1" %)(% colspan="1" %)
467 (((
468 Disables do not disturb on the specified extension.
469 )))
470
471 = Curl Examples =
472
473 === Get all extensions in a core server ===
474
475 {{code language="bash"}}
476 curl --user manager:manag3rpa55word -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4/extensions
477 {{/code}}
478
479 === (% style="color: rgb(0,0,0);" %)Get a specific extension in a core server(%%) ===
480
481 {{code language="bash"}}
482 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
483 {{/code}}
484
485 === (% style="color: rgb(0,0,0);" %)Get all extensions bound to a user(%%) ===
486
487 {{code language="bash"}}
488 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
489 {{/code}}
490
491 === (% style="color: rgb(0,0,0);" %)Get a specific extension bound to a user(%%) ===
492
493 {{code language="bash"}}
494 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
495 {{/code}}
496
497 === (% style="color: rgb(0,0,0);" %)Get the extension related to a specific queue agent(%%) ===
498
499 {{code language="bash"}}
500 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
501 {{/code}}
502
503 === Originate a call from a specific extension to a given number ===
504
505 {{code language="bash"}}
506 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
507 {{/code}}
508
509 === (% style="color: rgb(0,0,0);" %)Enable DND on a specific extension(%%) ===
510
511 {{code language="bash"}}
512 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
513 {{/code}}
514
515 === Disable DND on a specific extension ===
516
517 {{code language="bash"}}
518 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
519 {{/code}}
520 {{/layout-cell}}
521 {{/layout-section}}
522 {{/layout}}