Skip to Content

Wiki source code of Call Segments

Version 21.1 by michaely on 2015/07/13 15:12
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 call segment REST resource provides access to information about call segments in the system, including call segments bound to an extension, waiting in a queue, or related to other call segments. This resource provides actions to transfer call segments to other destinations.
19
20 {{info}}
21 This resource does not provide any sub resources, but does provide references to other call segments, as the relationships between call segments represent call state between two endpoints.
22 {{/info}}
23 {{/layout-cell}}
24
25 {{layout-cell}}
26 {{panel title="On this page:"}}
27
28
29 {{toc maxLevel="2" indent="1"/}}
30 {{/panel}}
31 {{/layout-cell}}
32 {{/layout-section}}
33
34 {{layout-section ac:type="single"}}
35 {{layout-cell}}
36 (% style="color: rgb(0,0,0);" %)
37
38
39 = (% style="color: rgb(0,0,0);" %)JSON Representation(%%) =
40
41 {{code}}
42 {
43 "id": "804dbbc2-c4e3-47f2-96b9-b8262d542e7c",
44 "type": "INTERNAL",
45 "callerId": {
46 "id": "c9450235-0f6d-4e0f-bb3b-3fef010d8617",
47 "name": "Michael Y",
48 "number": "4224"
49 },
50 "did": "s",
51 "onHold": false,
52 "recording": false,
53 "incoming": true,
54 }
55 {{/code}}
56
57 (% style="line-height: 1.4285715;" %)
58 |=(((
59 Property
60 )))|=(((
61 Type
62 )))|=(((
63 Description
64 )))
65 |(((
66 {{{id}}}
67 )))|(((
68 String
69 )))|(((
70 The id of the call segment.
71 )))
72 |(% colspan="1" %)(% colspan="1" %)
73 (((
74 type
75 )))|(% colspan="1" %)(% colspan="1" %)
76 (((
77 String
78 )))|(% colspan="1" %)(% colspan="1" %)
79 (((
80 The Type of the call segment. Values are (% style="font-family: monospace;" %)Internal(%%) (Call Segment is bound to an internal extension), and External (Call Segment is bound to an external source).
81
82 {{info}}
83 If the system cannot determine the extension a call segment is bound to (i.e. the extension is not configured in iSymphony), the type will be set to External.
84 {{/info}}
85 )))
86 |(% colspan="1" %)(% colspan="1" %)
87 (((
88 callerId:id
89 )))|(% colspan="1" %)(% colspan="1" %)
90 (((
91 String
92 )))|(% colspan="1" %)(% colspan="1" %)
93 (((
94 The id of the call segment's caller id object.
95 )))
96 |(% colspan="1" %)(% colspan="1" %)
97 (((
98 callerId:name
99
100 {{{}}}
101 )))|(% colspan="1" %)(% colspan="1" %)
102 (((
103 String
104 )))|(% colspan="1" %)(% colspan="1" %)
105 (((
106 The caller id name of the call segment.
107 )))
108 |(% colspan="1" %)(% colspan="1" %)
109 (((
110 {{{callerId:number}}}
111 )))|(% colspan="1" %)(% colspan="1" %)
112 (((
113 String
114 )))|(% colspan="1" %)(% colspan="1" %)
115 (((
116 The caller id number of the call segment.
117 )))
118 |(% colspan="1" %)(% colspan="1" %)
119 (((
120 did
121 )))|(% colspan="1" %)(% colspan="1" %)
122 (((
123 String
124 )))|(% colspan="1" %)(% colspan="1" %)
125 (((
126 The number the caller used to enter the phone system, or null if the call segment was created in response to a dial, or no DID could be determined for the call.
127 )))
128 |(% colspan="1" %)(% colspan="1" %)
129 (((
130 onHold
131 )))|(% colspan="1" %)(% colspan="1" %)
132 (((
133 Boolean
134 )))|(% colspan="1" %)(% colspan="1" %)
135 (((
136 Specifies if the current call segment is on hold or not.
137 )))
138 |(% colspan="1" %)(% colspan="1" %)
139 (((
140 recording
141 )))|(% colspan="1" %)(% colspan="1" %)
142 (((
143 Boolean
144 )))|(% colspan="1" %)(% colspan="1" %)
145 (((
146 Specifies if the call segment is currently being recorded or not.
147 )))
148 |(% colspan="1" %)(% colspan="1" %)
149 (((
150 incoming
151 )))|(% colspan="1" %)(% colspan="1" %)
152 (((
153 Boolean
154 )))|(% colspan="1" %)(% colspan="1" %)
155 (((
156 Species if the call segment is being dialed by another call segment (i.e. receiving a call)
157 )))
158
159 = Root Resource Paths =
160
161 Paths used to access sets of the resource, in relation to parent resources.
162
163 |=(% colspan="2" %)(% colspan="2" %)
164 (((
165 {{{communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/callSegments}}}
166 )))
167 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
168 (((
169 **Description**
170 )))|(((
171 Provides access to all call segments in a specified core server.
172
173 {{info}}
174 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.
175 {{/info}}
176
177 **Parameters:**
178
179 * core_server_id: the id of the parent core server\\
180 * core_server_slug: the slug of the parent core server
181
182 **Errors:**
183
184 * 404 Not Found: Returned if no core server with the given id or slug exists
185 )))
186 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
187 (((
188 **GET**
189 )))|(% colspan="1" %)(% colspan="1" %)
190 (((
191 Gets all call segments in the specified core server.
192 )))
193 |(% colspan="1" %)(% colspan="1" %)
194 (((
195
196 )))|(% colspan="1" %)(% colspan="1" %)
197 (((
198
199 )))
200 |=(% colspan="2" %)(% colspan="2" %)
201 (((
202 {{{communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/user/[{user_id} | getByName/{username}]/extensions/[{extensions_id} | getByName/{extension_number}]/callSegments}}}
203 )))
204 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
205 (((
206 **Description**
207 )))|(% colspan="1" %)(% colspan="1" %)
208 (((
209 Provides access to all call segments bound to a specified extension.
210
211 {{info}}
212 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.
213 {{/info}}
214
215 **Parameters:**
216
217 * core_server_id: the id of the parent core server\\
218 * core_server_slug: the slug of the parent core server
219 * extension_id: the id of the parent extension
220 * (% style="font-family: monospace;" %)extension_number(%%): the extension number of the parent extension
221
222 **Errors:**
223
224 * 404 Not Found: Returned if no core server with the given id or slug exists
225 * 404 Not Found: Returned if no user with the given id or username exists
226 * 403 Forbidden: Returned if the extension is not bound to a licensed/full user
227 )))
228 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
229 (((
230 **GET**
231 )))|(% colspan="1" %)(% colspan="1" %)
232 (((
233 Gets all call segment bound to a specified extension.
234 )))
235 |(% colspan="2" %)(% colspan="2" %)
236 (((
237
238 )))
239 |=(% colspan="2" %)(% colspan="2" %)
240 (((
241 {{{communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/callSegments/{call_segment_id}/dialingToCallSegments}}}
242 )))
243 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
244 (((
245 **Description**
246 )))|(% colspan="1" %)(% colspan="1" %)
247 (((
248 Provides access to all call segments the specified call segment is dialing.
249
250 {{info}}
251 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.
252 {{/info}}
253
254 **Parameters:**
255
256 * core_server_id: the id of the parent core server\\
257 * core_server_slug: the slug of the parent core server
258 * call_segment_id: the id of the parent call segment
259
260 **Errors:**
261
262 * 404 Not Found: Returned if no core server with the given id or slug exists
263 * 404 Not Found: Returned if no user with the given id or username exists
264 * 403 Forbidden: Returned if the extension is not bound to a licensed/full user
265 )))
266 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
267 (((
268 **GET**
269 )))|(% colspan="1" %)(% colspan="1" %)
270 (((
271 Gets all call segments the specified call segment is dialing.
272 )))
273
274 = Instance Resource Paths =
275
276 Paths used to access a specific instance of the resource.
277
278 |=(% colspan="2" %)(% colspan="2" %)
279 (((
280 {{{{root_resource_path}/{call_segment_id}}}}
281 )))
282 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
283 (((
284 **Description**
285 )))|(% colspan="1" %)(% colspan="1" %)
286 (((
287 Provides access to a specified call segment, by call segment id.
288
289 {{info}}
290 This resource will not be available if the specified call segment is not related to an extension that is bound to a licensed/full user, or has not been bound to another call segment that is related to an extension that is bound to a licensed/full user.
291 {{/info}}
292
293 **Parameters:**
294
295 * root_resource_path: One of the root resource paths for this resource. See Root Resource Paths above
296 * call_segment_id: the id of the call segment to access
297
298 **Errors:**
299
300 * 404 Not Found: Returned if any of the ancestors in the root resource path could not be found
301 * 404 Not Found: Returned if no call segment with the specified call segment id could be found
302 * 403 Forbidden: Returned if any of the parents specified in the root resource path are restricted
303 * 403 Forbidden: Returned if the specified call segment is not related to an extension that is bound to a licensed/full user, or has not been bound to another call segment that is related to an extension that is bound to a licensed/full user.
304 )))
305 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
306 (((
307 **GET**
308 )))|(% colspan="1" %)(% colspan="1" %)
309 (((
310 Gets the specified call segment.
311 )))
312 |(% colspan="2" %)(% colspan="2" %)
313 (((
314
315 )))
316 |=(% colspan="2" %)(% colspan="2" %)
317 (((
318 {{{communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/callSegments/{call_segment_id}/dialingFromCallSegment}}}
319 )))
320 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
321 (((
322 **Description**
323 )))|(% colspan="1" %)(% colspan="1" %)
324 (((
325 Provides access to the call segment that is dialing the specified call segment.
326
327 {{info}}
328 This resource will not be available if the specified call segment is not related to an extension that is bound to a licensed/full user, or has not been bound to another call segment that is related to an extension that is bound to a licensed/full user.
329 {{/info}}
330
331 **Parameters:**
332
333 * root_resource_path: One of the root resource paths for this resource. See Root Resource Paths above
334 * call_segment_id: the id of the parent call segment
335
336 **Errors:**
337
338 * 404 Not Found: Returned if any of the ancestors in the root resource path could not be found
339 * 404 Not Found: Returned if no call segment with the specified call segment id could be found
340 * 404 Not Found: Returned if the specified call segment is not being dialed by another call segment
341 * 403 Forbidden: Returned if the specified call segment is not related to an extension that is bound to a licensed/full user, or has not been bound to another call segment that is related to an extension that is bound to a licensed/full user.
342 )))
343 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
344 (((
345 **GET**
346 )))|(% colspan="1" %)(% colspan="1" %)
347 (((
348 Gets the call segment that is dialing the specified call segment.
349 )))
350 |(% colspan="2" %)(% colspan="2" %)
351 (((
352
353 )))
354 |=(% colspan="2" %)(% colspan="2" %)
355 (((
356 {{{communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/callSegments/{call_segment_id}/linkedCallSegment}}}
357 )))
358 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
359 (((
360 **Description**
361 )))|(% colspan="1" %)(% colspan="1" %)
362 (((
363 Provides access to the call segment that the specified call segment is linked to.
364
365 {{info}}
366 This resource will not be available if the specified call segment is not related to an extension that is bound to a licensed/full user, or has not been bound to another call segment that is related to an extension that is bound to a licensed/full user.
367 {{/info}}
368
369 **Parameters:**
370
371 * root_resource_path: One of the root resource paths for this resource. See Root Resource Paths above
372 * call_segment_id: the id of the parent call segment
373
374 **Errors:**
375
376 * 404 Not Found: Returned if any of the ancestors in the root resource path could not be found
377 * 404 Not Found: Returned if no call segment with the specified call segment id could be found
378 * 404 Not Found: Returned if the specified call segment is not linked to another call segment
379 * 403 Forbidden: Returned if the specified call segment is not related to an extension that is bound to a licensed/full user, or has not been bound to another call segment that is related to an extension that is bound to a licensed/full user.
380 )))
381 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
382 (((
383 **GET**
384 )))|(% colspan="1" %)(% colspan="1" %)
385 (((
386 Gets the call segment that the specified call segment is linked to.
387 )))
388
389 = Action Paths =
390
391 Actions that can be performed on this resource.
392
393 |=(% colspan="2" %)(% colspan="2" %)
394 (((
395 {{{{instance_resource_path}/transfer}}}
396 )))
397 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
398 (((
399 **Description**
400 )))|(((
401 Transfers the call segment, that is bound to the specified call segment.
402
403 {{info}}
404 This action will not be available if the specified call segment is not related to an extension that is bound to a licensed/full user, or has not been bound to another call segment that is related to an extension that is bound to a licensed/full user.
405 {{/info}}
406
407 {{note}}
408
409 {{/note}}
410
411 (% style="line-height: 1.4285715;" %)**Parameters:**
412
413 * instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above
414
415 **Errors:**
416
417 * 404 Not Found: Returned if any of the ancestors in the instance resource path could not be found
418 * 403 Forbidden(% style="line-height: 1.4285715;" %): Returned if the specified call segment is not related to an extension that is bound to a licensed/full user, or has not been bound to another call segment that is related to an extension that is bound to a licensed/full user.
419 * 422 Unprocessable Entity: Returned if no destination number value was provided(% style="line-height: 1.4285715;" %)
420
421 * 422 Unprocessable Entity: Returned if no attended value was provided
422 * 422 Unprocessable Entity: Returned if the attended value provided is not a boolean value
423 )))
424 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
425 (((
426 **JSON**
427 )))|(% colspan="1" %)(% colspan="1" %)
428 (((
429 {{code}}
430 {
431 "destinationNumber": "18005555555",
432 "attended" : false
433 }
434 {{/code}}
435
436 **Properties:**
437
438 |=(((
439 Property
440 )))|=(((
441 Type
442 )))|=(((
443 Description
444 )))
445 |(% colspan="1" %)(% colspan="1" %)
446 (((
447 {{{destinationNumber}}}
448 )))|(% colspan="1" %)(% colspan="1" %)
449 (((
450 String
451 )))|(% colspan="1" %)(% colspan="1" %)
452 (((
453 The number to transfer to.
454 )))
455 |(% colspan="1" %)(% colspan="1" %)
456 (((
457 attended
458 )))|(% colspan="1" %)(% colspan="1" %)
459 (((
460 Boolean
461 )))|(% colspan="1" %)(% colspan="1" %)
462 (((
463 Specifies if the transfer should be attended or not.
464
465 {{info}}
466 Attended transfers should no be performed, if the call source is not an extension.
467 {{/info}}
468 )))
469
470 **
471 **
472 )))
473 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
474 (((
475 **POST
476 **
477 )))|(% colspan="1" %)(% colspan="1" %)
478 (((
479 Transfers the call segment, that is bound to the specified call segment.
480 )))
481
482 = Curl Examples =
483
484 === Get all call segments in a core server ===
485
486 {{code language="bash"}}
487 curl --user manager:manag3rpa55word -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4/callSegments
488 {{/code}}
489
490 === (% style="color: rgb(0,0,0);" %)Get a specific call segment in a core server(%%) ===
491
492 {{code language="bash"}}
493 curl --user manager:manag3rpa55word -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4/callSegments/804dbbc2-c4e3-47f2-96b9-b8262d542e7c
494 {{/code}}
495
496 === (% style="color: rgb(0,0,0);" %)Get all call segments owned by an extension(%%) ===
497
498 {{code language="bash"}}
499 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/callSegments
500 {{/code}}
501
502 === (% style="color: rgb(0,0,0);" %)Get a specific call segment owned by an extension(%%) ===
503
504 {{code language="bash"}}
505 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/callSegments/804dbbc2-c4e3-47f2-96b9-b8262d542e7c
506 {{/code}}
507
508 === (% style="color: rgb(0,0,0);" %)Get all call segments a specified call segment is dialing(%%) ===
509
510 {{code language="bash"}}
511 curl --user manager:manag3rpa55word -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4/callSegments/804dbbc2-c4e3-47f2-96b9-b8262d542e7c/dialingToCallSegments
512 {{/code}}
513
514 === Get a specific call segment a specified call segment is dialing ===
515
516 {{code language="bash"}}
517 curl --user manager:manag3rpa55word -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4/callSegments/804dbbc2-c4e3-47f2-96b9-b8262d542e7c/dialingToCallSegments/63844df4-c8f5-4917-9948-30f6251fc763
518 {{/code}}
519
520 === Get the call segment that is dialing a specified call segment ===
521
522 {{code language="bash"}}
523 curl --user manager:manag3rpa55word -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4/callSegments/804dbbc2-c4e3-47f2-96b9-b8262d542e7c/dialingFromCallSegment
524 {{/code}}
525
526 === Get the call segment linked to a specified call segment ===
527
528 {{code language="bash"}}
529 curl --user manager:manag3rpa55word -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4/callSegments/804dbbc2-c4e3-47f2-96b9-b8262d542e7c/linkedCallSegment
530 {{/code}}
531
532 === Transfer the call segment the specified call segment is bound to ===
533
534 {{note}}
535 See notes in the transfer action path above, concerning which call segment to specify when performing a transfer action.
536 {{/note}}
537
538 {{code language="bash"}}
539 curl --user manager:manag3rpa55word -i -H "Content-Type: application/json" -X POST -d '{"destinationNumber": "18005555555", "attended" : false}' http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4/callSegments/804dbbc2-c4e3-47f2-96b9-b8262d542e7c/transfer
540 {{/code}}
541 {{/layout-cell}}
542 {{/layout-section}}
543 {{/layout}}