Wiki source code of Queues

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 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 [[doc: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 [[doc: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 [[doc: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}/loginAgent}}}
336 )))
337 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
338 (((
339 **Description**
340 )))|(((
341 Logs an extension into a specified queue, as an agent.
342
343 {{info}}
344 This action will not be available if the queue is not enabled.
345
346 This action will not be available if the extension is not bound to a licensed/full user.
347 {{/info}}
348
349 **Parameters:**
350
351 * instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above
352
353 **Errors:**
354
355 * 404 Not Found: Returned if any of the ancestors in the instance resource path could not be found
356 * 403 Forbidden: Returned if the queue is not enabled
357 * 403 Forbidden: Returned if if the extension is not bound to a licensed/full user
358 * 422 Unprocessable Entity: Returned if the extension with the specified id or extension number could not be found
359 * 422 Unprocessable Entity: Returned if the extension with the specified id or extension number is already a member of the queue
360 * 422 Unprocessable Entity: Returned if no information was provided to identify the extension to log into the queue
361 )))
362 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
363 (((
364 **JSON**
365 )))|(% colspan="1" %)(% colspan="1" %)
366 (((
367 {{info}}
368 The extension to log into the queue can be identified by the extension id or the extension number. If both are provided the extension id will be used.
369 {{/info}}
370
371 {{code}}
372 {
373 "extensionId": "ef2faba9-8557-49c1-9ffc-5a71f41c7a23"
374 }
375  
376 OR
377  
378 {
379 "extensionNumber": "100"
380 }
381 {{/code}}
382
383 **Properties:**
384
385 |=(((
386 Property
387 )))|=(((
388 Type
389 )))|=(((
390 Description
391 )))
392 |(% colspan="1" %)(% colspan="1" %)
393 (((
394 {{{extensionId}}}
395 )))|(% colspan="1" %)(% colspan="1" %)
396 (((
397 String
398 )))|(% colspan="1" %)(% colspan="1" %)
399 (((
400 The id of the extension to log into the queue.
401 )))
402 |(% colspan="1" %)(% colspan="1" %)
403 (((
404 {{{extensionNumber}}}
405 )))|(% colspan="1" %)(% colspan="1" %)
406 (((
407 String
408 )))|(% colspan="1" %)(% colspan="1" %)
409 (((
410 The number of the extension to log into the queue.
411 )))
412
413 **
414 **
415 )))
416 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
417 (((
418 **POST
419 **
420 )))|(% colspan="1" %)(% colspan="1" %)
421 (((
422 Log an extension into a specified queue, as an agent.
423 )))
424 |(% colspan="2" %)(% colspan="2" %)
425 (((
426
427 )))
428 |=(% colspan="2" %)(% colspan="2" %)
429 (((
430 {{{{instance_resource_path}/logoutAgent}}}
431 )))
432 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
433 (((
434 **Description**
435 )))|(% colspan="1" %)(% colspan="1" %)
436 (((
437 Logs a specified agent out of the queue.
438
439 {{info}}
440 This action will not be available if the queue is not enabled.
441
442 This action will not be available if the extension is not bound to a licensed/full user.
443 {{/info}}
444
445 **Parameters:**
446
447 * instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above
448
449 **Errors:**
450
451 * 404 Not Found: Returned if any of the ancestors in the instance resource path could not be found
452 * 403 Forbidden: Returned if if the extension is not bound to a licensed/full user
453 * 403 Forbidden: Returned if the queue is not enabled
454 * 422 Unprocessable Entity: Returned if the agent with the specified id could not be found
455 * 422 Unprocessable Entity: Returned if the agent with the specified extension id or extension number could not be found
456 * 422 Unprocessable Entity: Returned if no information was provided to specify the agent to log out of the queue
457 )))
458 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
459 (((
460 **JSON**
461 )))|(% colspan="1" %)(% colspan="1" %)
462 (((
463 {{info}}
464 The agent to log out of the queue can be identified by the agent id, extension id, or extension number. If more than one identifier is provided the agent id will be used, if provided. If the agent id is not provided the extension id will be utilized.
465 {{/info}}
466
467 {{code}}
468 {
469 "agentId": "ef2faba9-8557-49c1-9ffc-5a71f41c7a23"
470 }
471  
472 OR
473  
474 {
475 "extensionId": "ef2faba9-8557-49c1-9ffc-5a71f41c7a23"
476 }
477  
478 OR
479  
480 {
481 "extensionNumber": "100"
482 }
483 {{/code}}
484
485 **Properties:**
486
487 |=(((
488 Property
489 )))|=(((
490 Type
491 )))|=(((
492 Description
493 )))
494 |(% colspan="1" %)(% colspan="1" %)
495 (((
496 agentId
497 )))|(% colspan="1" %)(% colspan="1" %)
498 (((
499 String
500 )))|(% colspan="1" %)(% colspan="1" %)
501 (((
502 The id of the agent to log out of the queue.
503 )))
504 |(% colspan="1" %)(% colspan="1" %)
505 (((
506 {{{extensionId}}}
507 )))|(% colspan="1" %)(% colspan="1" %)
508 (((
509 String
510 )))|(% colspan="1" %)(% colspan="1" %)
511 (((
512 The id of the extension to log out of the queue.
513 )))
514 |(% colspan="1" %)(% colspan="1" %)
515 (((
516 {{{extensionNumber}}}
517 )))|(% colspan="1" %)(% colspan="1" %)
518 (((
519 String
520 )))|(% colspan="1" %)(% colspan="1" %)
521 (((
522 The number of the extension to log out of the queue.
523 )))
524 )))
525 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
526 (((
527 **POST**
528 )))|(% colspan="1" %)(% colspan="1" %)
529 (((
530 Log a specified agent out of the queue.
531 )))
532
533 = Curl Examples =
534
535 === Get all queues in a core server ===
536
537 {{code language="bash"}}
538 curl --user manager:manag3rpa55word -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4/queues
539 {{/code}}
540
541 === (% style="color: rgb(0,0,0);" %)Get a specific queue in a core server(%%) ===
542
543 {{code language="bash"}}
544 curl --user manager:manag3rpa55word -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4/queues/7a2eeb64-24e1-418f-97fd-28880ba6539e
545 {{/code}}
546
547 === Log a specific extension into a queue as an agent ===
548
549 {{code language="bash"}}
550 curl --user manager:manag3rpa55word -i -H "Content-Type: application/json" -X POST -d '{"extensionId": "ef2faba9-8557-49c1-9ffc-5a71f41c7a23"}' http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4/queues/7a2eeb64-24e1-418f-97fd-28880ba6539e/loginAgent
551 {{/code}}
552
553 === Log a specific agent out of a queue ===
554
555 {{code language="bash"}}
556 curl --user manager:manag3rpa55word -i -H "Content-Type: application/json" -X POST -d '{"agentId": "ef2faba9-8557-49c1-9ffc-5a71f41c7a23"}' http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4/queues/7a2eeb64-24e1-418f-97fd-28880ba6539e/logoutAgent
557 {{/code}}
558 {{/layout-cell}}
559 {{/layout-section}}
560 {{/layout}}

Search

Navigation

iSymphony