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