Skip to Content

Wiki source code of Call Segments

Version 27.1 by hanlys on 2016/01/05 18:57
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}]/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(% 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.
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 The call segment that is specified in the path is not the call segment that will be transferred. The call segment that is bound to the specified call segment (e.g. linked call segment or dialing from call segment) will be transferred.
409
410 For example:
411
412 If extension 100 and 200 are on a linked call, and you wish to transfer the user behind extension 200 to another destination, you must execute the transfer action on extension 100's call segment.
413 {{/note}}
414
415 (% style="line-height: 1.4285715;" %)**Parameters:**
416
417 * instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above
418
419 **Errors:**
420
421 * 404 Not Found: Returned if any of the ancestors in the instance resource path could not be found
422 * 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.
423 * 422 Unprocessable Entity: Returned if no destination number value was provided(% style="line-height: 1.4285715;" %)
424
425 * 422 Unprocessable Entity: Returned if no attended value was provided
426 * 422 Unprocessable Entity: Returned if the attended value provided is not a boolean value
427 )))
428 |=(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
429 (((
430 **JSON**
431 )))|(% colspan="1" %)(% colspan="1" %)
432 (((
433 {{code}}
434 {
435 "destinationNumber": "18005555555",
436 "attended" : false
437 }
438 {{/code}}
439
440 **Properties:**
441
442 |=(((
443 Property
444 )))|=(((
445 Type
446 )))|=(((
447 Description
448 )))
449 |(% colspan="1" %)(% colspan="1" %)
450 (((
451 {{{destinationNumber}}}
452 )))|(% colspan="1" %)(% colspan="1" %)
453 (((
454 String
455 )))|(% colspan="1" %)(% colspan="1" %)
456 (((
457 The number to transfer to.
458 )))
459 |(% colspan="1" %)(% colspan="1" %)
460 (((
461 attended
462 )))|(% colspan="1" %)(% colspan="1" %)
463 (((
464 Boolean
465 )))|(% colspan="1" %)(% colspan="1" %)
466 (((
467 Specifies if the transfer should be attended or not.
468
469 {{info}}
470 Attended transfers should no be performed, if the call source is not an extension.
471 {{/info}}
472 )))
473
474 **
475 **
476 )))
477 |=(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
478 (((
479 **POST
480 **
481 )))|(% colspan="1" %)(% colspan="1" %)
482 (((
483 Transfers the call segment, that is bound to the specified call segment.
484 )))
485 |=(% colspan="2" %)(% colspan="2" %)
486 (((
487 {{{{instance_resource_path}/kick}}}
488 )))
489 |=(% colspan="1" %)(% colspan="1" %)
490 (((
491 **Description**
492 )))|(% colspan="1" %)(% colspan="1" %)
493 (((
494 Kicks the call segment from it's current conference room.
495
496 {{info}}
497 (% style="list-style-type: square;" %)
498 * This action is only available for call segments that are in conference rooms.
499 * This action is only available on servers that have conference rooms enabled.
500 {{/info}}
501
502 **Errors:**
503
504 * 404 Not Found: Returned if any of the ancestors in the instance resource path could not be found.
505 * 500 Internal Server Error: Returned if the specified call segment is not on a server with conference rooms enabled.
506 )))
507 |=(% colspan="1" %)(% colspan="1" %)
508 (((
509 **POST**
510 )))|(% colspan="1" %)(% colspan="1" %)
511 (((
512 Kicks the call segment from a conference room.
513 )))
514 |=(% colspan="2" %)(% colspan="2" %)
515 (((
516 {{{{instance_resource_path}/mute}}}
517 )))
518 |=(% colspan="1" %)(% colspan="1" %)
519 (((
520 **Description**
521 )))|(% colspan="1" %)(% colspan="1" %)
522 (((
523 Mutes the call segment in the conference room.
524
525 {{info}}
526 * This action is only available for call segments that are in conference rooms.
527 * This action is only available on servers that have conference rooms enabled.
528 {{/info}}
529
530 **Errors:**
531
532 * 404 Not Found: Returned if any of the ancestors in the instance resource path could not be found.
533 * 500 Internal Server Error(% style="line-height: 1.42857;" %): Returned if the specified call segment is not on a server with conference rooms enabled.
534 )))
535 |=(% colspan="1" %)(% colspan="1" %)
536 (((
537 **POST**
538 )))|(% colspan="1" %)(% colspan="1" %)
539 (((
540 Mutes the call segment in a conference room.
541 )))
542 |=(% colspan="2" %)(% colspan="2" %)
543 (((
544 {{{{instance_resource_path}/unmute}}}
545 )))
546 |=(% colspan="1" %)(% colspan="1" %)
547 (((
548
549 )))|(% colspan="1" %)(% colspan="1" %)
550 (((
551 Unmutes the call segment in the conference room.
552
553 {{info}}
554 * This action is only available for call segments that are in conference rooms.
555 * This action is only available on servers that have conference rooms enabled.
556 {{/info}}
557
558 **Errors:**
559
560 * 404 Not Found: Returned if any of the ancestors in the instance resource path could not be found.
561 * 500 Internal Server Error(% style="line-height: 1.42857;" %): Returned if the specified call segment is not on a server with conference rooms enabled.
562 )))
563 |=(% colspan="1" %)(% colspan="1" %)
564 (((
565 **POST**
566 )))|(% colspan="1" %)(% colspan="1" %)
567 (((
568 Unmutes the call segment in a conference room.
569 )))
570
571
572
573 = Curl Examples =
574
575 === Get all call segments in a core server ===
576
577 {{code language="bash"}}
578 curl --user manager:manag3rpa55word -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4/callSegments
579 {{/code}}
580
581 === (% style="color: rgb(0,0,0);" %)Get a specific call segment in a core server(%%) ===
582
583 {{code language="bash"}}
584 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
585 {{/code}}
586
587 === (% style="color: rgb(0,0,0);" %)Get all call segments owned by an extension(%%) ===
588
589 {{code language="bash"}}
590 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
591 {{/code}}
592
593 === (% style="color: rgb(0,0,0);" %)Get a specific call segment owned by an extension(%%) ===
594
595 {{code language="bash"}}
596 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
597 {{/code}}
598
599 === (% style="color: rgb(0,0,0);" %)Get all call segments a specified call segment is dialing(%%) ===
600
601 {{code language="bash"}}
602 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
603 {{/code}}
604
605 === Get a specific call segment a specified call segment is dialing ===
606
607 {{code language="bash"}}
608 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
609 {{/code}}
610
611 === Get the call segment that is dialing a specified call segment ===
612
613 {{code language="bash"}}
614 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
615 {{/code}}
616
617 === Get the call segment linked to a specified call segment ===
618
619 {{code language="bash"}}
620 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
621 {{/code}}
622
623 === Transfer the call segment the specified call segment is bound to ===
624
625 {{note}}
626 See notes in the transfer action path above, concerning which call segment to specify when performing a transfer action.
627 {{/note}}
628
629 {{code language="bash"}}
630 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
631 {{/code}}
632 {{/layout-cell}}
633 {{/layout-section}}
634 {{/layout}}
635
636 {{layout}}
637 {{layout-section ac:type="two_right_sidebar"}}
638 {{layout-cell}}
639 {{warning}}
640 This page is currently being written. Although the information below is probably accurate, it may not be complete or may have errors.
641 {{/warning}}
642
643 {{info}}
644 The information on this page applies to **iSymphony 3.2+**.
645 {{/info}}
646
647 {{note}}
648 This resource is restricted by licensing. See the resource and action path information below for more details.
649 {{/note}}
650
651 = (% style="color: rgb(0,0,0);" %)Description(%%) =
652
653 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.
654
655 {{info}}
656 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.
657 {{/info}}
658 {{/layout-cell}}
659
660 {{layout-cell}}
661 {{panel title="On this page:"}}
662
663
664 {{toc maxLevel="2" indent="1"/}}
665 {{/panel}}
666 {{/layout-cell}}
667 {{/layout-section}}
668
669 {{layout-section ac:type="single"}}
670 {{layout-cell}}
671 (% style="color: rgb(0,0,0);" %)
672
673
674 = (% style="color: rgb(0,0,0);" %)JSON Representation(%%) =
675
676 {{code}}
677 {
678 "id": "804dbbc2-c4e3-47f2-96b9-b8262d542e7c",
679 "type": "INTERNAL",
680 "callerId": {
681 "id": "c9450235-0f6d-4e0f-bb3b-3fef010d8617",
682 "name": "Michael Y",
683 "number": "4224"
684 },
685 "did": "s",
686 "onHold": false,
687 "recording": false,
688 "incoming": true,
689 }
690 {{/code}}
691
692 (% style="line-height: 1.4285715;" %)
693 |=(((
694 Property
695 )))|=(((
696 Type
697 )))|=(((
698 Description
699 )))
700 |(((
701 {{{id}}}
702 )))|(((
703 String
704 )))|(((
705 The id of the call segment.
706 )))
707 |(% colspan="1" %)(% colspan="1" %)
708 (((
709 type
710 )))|(% colspan="1" %)(% colspan="1" %)
711 (((
712 String
713 )))|(% colspan="1" %)(% colspan="1" %)
714 (((
715 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).
716
717 {{info}}
718 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.
719 {{/info}}
720 )))
721 |(% colspan="1" %)(% colspan="1" %)
722 (((
723 callerId:id
724 )))|(% colspan="1" %)(% colspan="1" %)
725 (((
726 String
727 )))|(% colspan="1" %)(% colspan="1" %)
728 (((
729 The id of the call segment's caller id object.
730 )))
731 |(% colspan="1" %)(% colspan="1" %)
732 (((
733 callerId:name
734
735 {{{}}}
736 )))|(% colspan="1" %)(% colspan="1" %)
737 (((
738 String
739 )))|(% colspan="1" %)(% colspan="1" %)
740 (((
741 The caller id name of the call segment.
742 )))
743 |(% colspan="1" %)(% colspan="1" %)
744 (((
745 {{{callerId:number}}}
746 )))|(% colspan="1" %)(% colspan="1" %)
747 (((
748 String
749 )))|(% colspan="1" %)(% colspan="1" %)
750 (((
751 The caller id number of the call segment.
752 )))
753 |(% colspan="1" %)(% colspan="1" %)
754 (((
755 did
756 )))|(% colspan="1" %)(% colspan="1" %)
757 (((
758 String
759 )))|(% colspan="1" %)(% colspan="1" %)
760 (((
761 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.
762 )))
763 |(% colspan="1" %)(% colspan="1" %)
764 (((
765 onHold
766 )))|(% colspan="1" %)(% colspan="1" %)
767 (((
768 Boolean
769 )))|(% colspan="1" %)(% colspan="1" %)
770 (((
771 Specifies if the current call segment is on hold or not.
772 )))
773 |(% colspan="1" %)(% colspan="1" %)
774 (((
775 recording
776 )))|(% colspan="1" %)(% colspan="1" %)
777 (((
778 Boolean
779 )))|(% colspan="1" %)(% colspan="1" %)
780 (((
781 Specifies if the call segment is currently being recorded or not.
782 )))
783 |(% colspan="1" %)(% colspan="1" %)
784 (((
785 incoming
786 )))|(% colspan="1" %)(% colspan="1" %)
787 (((
788 Boolean
789 )))|(% colspan="1" %)(% colspan="1" %)
790 (((
791 Species if the call segment is being dialed by another call segment (i.e. receiving a call)
792 )))
793
794 = Root Resource Paths =
795
796 Paths used to access sets of the resource, in relation to parent resources.
797
798 |=(% colspan="2" %)(% colspan="2" %)
799 (((
800 {{{communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/callSegments}}}
801 )))
802 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
803 (((
804 **Description**
805 )))|(((
806 Provides access to all call segments in a specified core server.
807
808 {{info}}
809 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.
810 {{/info}}
811
812 **Parameters:**
813
814 * core_server_id: the id of the parent core server\\
815 * core_server_slug: the slug of the parent core server
816
817 **Errors:**
818
819 * 404 Not Found: Returned if no core server with the given id or slug exists
820 )))
821 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
822 (((
823 **GET**
824 )))|(% colspan="1" %)(% colspan="1" %)
825 (((
826 Gets all call segments in the specified core server.
827 )))
828 |(% colspan="1" %)(% colspan="1" %)
829 (((
830
831 )))|(% colspan="1" %)(% colspan="1" %)
832 (((
833
834 )))
835 |=(% colspan="2" %)(% colspan="2" %)
836 (((
837 {{{communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/extensions/[{extensions_id} | getByName/{extension_number}]/callSegments}}}
838 )))
839 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
840 (((
841 **Description**
842 )))|(% colspan="1" %)(% colspan="1" %)
843 (((
844 Provides access to all call segments bound to a specified extension.
845
846 {{info}}
847 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.
848 {{/info}}
849
850 **Parameters:**
851
852 * core_server_id: the id of the parent core server\\
853 * core_server_slug: the slug of the parent core server
854 * extension_id: the id of the parent extension
855 * (% style="font-family: monospace;" %)extension_number(%%): the extension number of the parent extension
856
857 **Errors:**
858
859 * 404 Not Found: Returned if no core server with the given id or slug exists
860 * 404 Not Found: Returned if no user with the given id or username exists
861 * 403 Forbidden: Returned if the extension is not bound to a licensed/full user
862 )))
863 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
864 (((
865 **GET**
866 )))|(% colspan="1" %)(% colspan="1" %)
867 (((
868 Gets all call segment bound to a specified extension.
869 )))
870 |(% colspan="2" %)(% colspan="2" %)
871 (((
872
873 )))
874 |=(% colspan="2" %)(% colspan="2" %)
875 (((
876 {{{communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/callSegments/{call_segment_id}/dialingToCallSegments}}}
877 )))
878 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
879 (((
880 **Description**
881 )))|(% colspan="1" %)(% colspan="1" %)
882 (((
883 Provides access to all call segments the specified call segment is dialing.
884
885 {{info}}
886 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.
887 {{/info}}
888
889 **Parameters:**
890
891 * core_server_id: the id of the parent core server\\
892 * core_server_slug: the slug of the parent core server
893 * call_segment_id: the id of the parent call segment
894
895 **Errors:**
896
897 * 404 Not Found: Returned if no core server with the given id or slug exists
898 * 404 Not Found: Returned if no user with the given id or username exists
899 * 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.
900 )))
901 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
902 (((
903 **GET**
904 )))|(% colspan="1" %)(% colspan="1" %)
905 (((
906 Gets all call segments the specified call segment is dialing.
907 )))
908
909 = Instance Resource Paths =
910
911 Paths used to access a specific instance of the resource.
912
913 |=(% colspan="2" %)(% colspan="2" %)
914 (((
915 {{{{root_resource_path}/{call_segment_id}}}}
916 )))
917 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
918 (((
919 **Description**
920 )))|(% colspan="1" %)(% colspan="1" %)
921 (((
922 Provides access to a specified call segment, by call segment id.
923
924 {{info}}
925 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.
926 {{/info}}
927
928 **Parameters:**
929
930 * root_resource_path: One of the root resource paths for this resource. See Root Resource Paths above
931 * call_segment_id: the id of the call segment to access
932
933 **Errors:**
934
935 * 404 Not Found: Returned if any of the ancestors in the root resource path could not be found
936 * 404 Not Found: Returned if no call segment with the specified call segment id could be found
937 * 403 Forbidden: Returned if any of the parents specified in the root resource path are restricted
938 * 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.
939 )))
940 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
941 (((
942 **GET**
943 )))|(% colspan="1" %)(% colspan="1" %)
944 (((
945 Gets the specified call segment.
946 )))
947 |(% colspan="2" %)(% colspan="2" %)
948 (((
949
950 )))
951 |=(% colspan="2" %)(% colspan="2" %)
952 (((
953 {{{communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/callSegments/{call_segment_id}/dialingFromCallSegment}}}
954 )))
955 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
956 (((
957 **Description**
958 )))|(% colspan="1" %)(% colspan="1" %)
959 (((
960 Provides access to the call segment that is dialing the specified call segment.
961
962 {{info}}
963 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.
964 {{/info}}
965
966 **Parameters:**
967
968 * root_resource_path: One of the root resource paths for this resource. See Root Resource Paths above
969 * call_segment_id: the id of the parent call segment
970
971 **Errors:**
972
973 * 404 Not Found: Returned if any of the ancestors in the root resource path could not be found
974 * 404 Not Found: Returned if no call segment with the specified call segment id could be found
975 * 404 Not Found: Returned if the specified call segment is not being dialed by another call segment
976 * 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.
977 )))
978 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
979 (((
980 **GET**
981 )))|(% colspan="1" %)(% colspan="1" %)
982 (((
983 Gets the call segment that is dialing the specified call segment.
984 )))
985 |(% colspan="2" %)(% colspan="2" %)
986 (((
987
988 )))
989 |=(% colspan="2" %)(% colspan="2" %)
990 (((
991 {{{communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/callSegments/{call_segment_id}/linkedCallSegment}}}
992 )))
993 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
994 (((
995 **Description**
996 )))|(% colspan="1" %)(% colspan="1" %)
997 (((
998 Provides access to the call segment that the specified call segment is linked to.
999
1000 {{info}}
1001 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.
1002 {{/info}}
1003
1004 **Parameters:**
1005
1006 * root_resource_path: One of the root resource paths for this resource. See Root Resource Paths above
1007 * call_segment_id: the id of the parent call segment
1008
1009 **Errors:**
1010
1011 * 404 Not Found: Returned if any of the ancestors in the root resource path could not be found
1012 * 404 Not Found: Returned if no call segment with the specified call segment id could be found
1013 * 404 Not Found: Returned if the specified call segment is not linked to another call segment
1014 * 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.
1015 )))
1016 |(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
1017 (((
1018 **GET**
1019 )))|(% colspan="1" %)(% colspan="1" %)
1020 (((
1021 Gets the call segment that the specified call segment is linked to.
1022 )))
1023
1024 = Action Paths =
1025
1026 Actions that can be performed on this resource.
1027
1028 |=(% colspan="2" %)(% colspan="2" %)
1029 (((
1030 {{{{instance_resource_path}/transfer}}}
1031 )))
1032 |=(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
1033 (((
1034 **Description**
1035 )))|(((
1036 Transfers the call segment, that is bound to the specified call segment.
1037
1038 {{info}}
1039 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.
1040 {{/info}}
1041
1042 {{note}}
1043 The call segment that is specified in the path is not the call segment that will be transferred. The call segment that is bound to the specified call segment (e.g. linked call segment or dialing from call segment) will be transferred.
1044
1045 For example:
1046
1047 If extension 100 and 200 are on a linked call, and you wish to transfer the user behind extension 200 to another destination, you must execute the transfer action on extension 100's call segment.
1048 {{/note}}
1049
1050 (% style="line-height: 1.4285715;" %)**Parameters:**
1051
1052 * instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above
1053
1054 **Errors:**
1055
1056 * 404 Not Found: Returned if any of the ancestors in the instance resource path could not be found
1057 * 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.
1058 * 422 Unprocessable Entity: Returned if no destination number value was provided(% style="line-height: 1.4285715;" %)
1059
1060 * 422 Unprocessable Entity: Returned if no attended value was provided
1061 * 422 Unprocessable Entity: Returned if the attended value provided is not a boolean value
1062 )))
1063 |=(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
1064 (((
1065 **JSON**
1066 )))|(% colspan="1" %)(% colspan="1" %)
1067 (((
1068 {{code}}
1069 {
1070 "destinationNumber": "18005555555",
1071 "attended" : false
1072 }
1073 {{/code}}
1074
1075 **Properties:**
1076
1077 |=(((
1078 Property
1079 )))|=(((
1080 Type
1081 )))|=(((
1082 Description
1083 )))
1084 |(% colspan="1" %)(% colspan="1" %)
1085 (((
1086 {{{destinationNumber}}}
1087 )))|(% colspan="1" %)(% colspan="1" %)
1088 (((
1089 String
1090 )))|(% colspan="1" %)(% colspan="1" %)
1091 (((
1092 The number to transfer to.
1093 )))
1094 |(% colspan="1" %)(% colspan="1" %)
1095 (((
1096 attended
1097 )))|(% colspan="1" %)(% colspan="1" %)
1098 (((
1099 Boolean
1100 )))|(% colspan="1" %)(% colspan="1" %)
1101 (((
1102 Specifies if the transfer should be attended or not.
1103
1104 {{info}}
1105 Attended transfers should no be performed, if the call source is not an extension.
1106 {{/info}}
1107 )))
1108
1109 **
1110 **
1111 )))
1112 |=(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="1" data-highlight-colour="grey" %)
1113 (((
1114 **POST
1115 **
1116 )))|(% colspan="1" %)(% colspan="1" %)
1117 (((
1118 Transfers the call segment, that is bound to the specified call segment.
1119 )))
1120 |=(% colspan="2" %)(% colspan="2" %)
1121 (((
1122 {{{{instance_resource_path}/kick}}}
1123 )))
1124 |=(% colspan="1" %)(% colspan="1" %)
1125 (((
1126 **Description**
1127 )))|(% colspan="1" %)(% colspan="1" %)
1128 (((
1129 Kicks the call segment from it's conference room.
1130
1131 {{info}}
1132 (% style="list-style-type: square;" %)
1133 * This action is only available for call segments that are in conference rooms.
1134 * This action is only available on servers that have conference rooms enabled.
1135 {{/info}}
1136
1137 **Errors:**
1138
1139 * 404 Not Found: Returned if any of the ancestors in the instance resource path could not be found.
1140 * 500 Internal Server Error: Returned if the core server does not have conference rooms enabled.
1141 )))
1142 |=(% colspan="2" %)(% colspan="2" %)
1143 (((
1144 {{{{instance_resource_path}/mute}}}
1145 )))
1146 |=(% colspan="1" %)(% colspan="1" %)
1147 (((
1148 **Description**
1149 )))|(% colspan="1" %)(% colspan="1" %)
1150 (((
1151 Mutes the call segment in it's conference room.
1152
1153 {{info}}
1154 * This action is only available for call segments that are in conference rooms.
1155 * This action is only available on servers that have conference rooms enabled.
1156 {{/info}}
1157
1158 **Errors:**
1159
1160 * 404 Not Found: Returned if any of the ancestors in the instance resource path could not be found.
1161
1162 * 500 Internal Server Error: Returned if the core server does not have conference rooms enabled.
1163 )))
1164 |=(% colspan="2" %)(% colspan="2" %)
1165 (((
1166 {{{{instance_resource_path}/unmute}}}
1167 )))
1168 |=(% colspan="1" %)(% colspan="1" %)
1169 (((
1170 **Description**
1171 )))|(% colspan="1" %)(% colspan="1" %)
1172 (((
1173 Unmutes the call segment in it's conference room.
1174
1175 {{info}}
1176 * This action is only available for call segments that are in conference rooms.
1177 * This action is only available on servers that have conference rooms enabled.
1178 {{/info}}
1179
1180 **Errors:**
1181
1182 * 404 Not Found: Returned if any of the ancestors in the instance resource path could not be found.
1183
1184 * 500 Internal Server Error: Returned if the core server does not have conference rooms enabled.
1185 )))
1186
1187
1188
1189 = Curl Examples =
1190
1191 === Get all call segments in a core server ===
1192
1193 {{code language="bash"}}
1194 curl --user manager:manag3rpa55word -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4/callSegments
1195 {{/code}}
1196
1197 === (% style="color: rgb(0,0,0);" %)Get a specific call segment in a core server(%%) ===
1198
1199 {{code language="bash"}}
1200 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
1201 {{/code}}
1202
1203 === (% style="color: rgb(0,0,0);" %)Get all call segments owned by an extension(%%) ===
1204
1205 {{code language="bash"}}
1206 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
1207 {{/code}}
1208
1209 === (% style="color: rgb(0,0,0);" %)Get a specific call segment owned by an extension(%%) ===
1210
1211 {{code language="bash"}}
1212 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
1213 {{/code}}
1214
1215 === (% style="color: rgb(0,0,0);" %)Get all call segments a specified call segment is dialing(%%) ===
1216
1217 {{code language="bash"}}
1218 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
1219 {{/code}}
1220
1221 === Get a specific call segment a specified call segment is dialing ===
1222
1223 {{code language="bash"}}
1224 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
1225 {{/code}}
1226
1227 === Get the call segment that is dialing a specified call segment ===
1228
1229 {{code language="bash"}}
1230 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
1231 {{/code}}
1232
1233 === Get the call segment linked to a specified call segment ===
1234
1235 {{code language="bash"}}
1236 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
1237 {{/code}}
1238
1239 === Transfer the call segment the specified call segment is bound to ===
1240
1241 {{note}}
1242 See notes in the transfer action path above, concerning which call segment to specify when performing a transfer action.
1243 {{/note}}
1244
1245 {{code language="bash"}}
1246 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
1247 {{/code}}
1248
1249 === Kicks the specified call segment from it's conference room ===
1250
1251 {{code language="bash"}}
1252 curl --user manager:manag3rpa55word -i -H "Content-Type: application/json" -X POST -d '{}' http://localhost:58080/communication_manager/rest/live/coreServers/getByName/default/conferences/8f907b96-77aa-49ed-b5de-990ce5c8e7e7/callSegments/ac3a4f88-b853-4998-a375-6fef458f7769/kick
1253 {{/code}}
1254
1255 === (% style="color: rgb(0,0,0);" %)Mute the specified call segment in it's conference room(%%) ===
1256
1257 {{code language="bash"}}
1258 curl --user manager:manag3rpa55word -i -H "Content-Type: application/json" -X POST -d '{}' http://localhost:58080/communication_manager/rest/live/coreServers/getByName/default/conferences/8f907b96-77aa-49ed-b5de-990ce5c8e7e7/callSegments/ac3a4f88-b853-4998-a375-6fef458f7769/mute
1259 {{/code}}
1260
1261 === Unmutes the specified call segment in it's conference room ===
1262
1263 {{code language="bash"}}
1264 curl --user manager:manag3rpa55word -i -H "Content-Type: application/json" -X POST -d '{}' http://localhost:58080/communication_manager/rest/live/coreServers/getByName/default/conferences/8f907b96-77aa-49ed-b5de-990ce5c8e7e7/callSegments/ac3a4f88-b853-4998-a375-6fef458f7769/unmute
1265 {{/code}}
1266
1267
1268
1269
1270 {{/layout-cell}}
1271 {{/layout-section}}
1272 {{/layout}}