Call Segments

Last modified by michaely on 2021/09/10 23:34

This page is currently being written. Although the information below is probably accurate, it may not be complete or may have errors.

The information on this page applies to iSymphony 3.2+.

This resource is restricted by licensing. See the resource and action path information below for more details.

Description

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.

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.

On this page:

The [toc] macro is a standalone macro and it cannot be used inline. Click on this message for details.
This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it.

JSON Representation

{
"id": "804dbbc2-c4e3-47f2-96b9-b8262d542e7c",
"type": "INTERNAL",
"callerId": {
   "id": "c9450235-0f6d-4e0f-bb3b-3fef010d8617",
   "name": "Michael Y",
   "number": "4224"
},
"did": "s",
"onHold": false,
"recording": false,
"incoming": true,
}

Property	Type	Description
id	String	The id of the call segment.
type	String	The Type of the call segment. Values are Internal (Call Segment is bound to an internal extension), and External (Call Segment is bound to an external source). Information 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.
callerId:id	String	The id of the call segment's caller id object.
callerId:name	String	The caller id name of the call segment.
callerId:number	String	The caller id number of the call segment.
did	String	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.
onHold	Boolean	Specifies if the current call segment is on hold or not.
recording	Boolean	Specifies if the call segment is currently being recorded or not.
incoming	Boolean	Species if the call segment is being dialed by another call segment (i.e. receiving a call)

Root Resource Paths

Paths used to access sets of the resource, in relation to parent resources.

communication_manager/rest/live/coreServers/[{core_server_id} \| getByName/{core_server_slug}]/callSegments
Description	Provides access to all call segments in a specified core server. Information 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. Parameters: core_server_id: the id of the parent core server core_server_slug: the slug of the parent core server Errors: 404 Not Found: Returned if no core server with the given id or slug exists
GET	Gets all call segments in the specified core server.

communication_manager/rest/live/coreServers/[{core_server_id} \| getByName/{core_server_slug}]/extensions/[{extensions_id} \| getByName/{extension_number}]/callSegments
Description	Provides access to all call segments bound to a specified extension. Information 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. Parameters: core_server_id: the id of the parent core server core_server_slug: the slug of the parent core server extension_id: the id of the parent extension extension_number: the extension number of the parent extension Errors: 404 Not Found: Returned if no core server with the given id or slug exists 404 Not Found: Returned if no user with the given id or username exists 403 Forbidden: Returned if the extension is not bound to a licensed/full user
GET	Gets all call segment bound to a specified extension.

communication_manager/rest/live/coreServers/[{core_server_id} \| getByName/{core_server_slug}]/callSegments/{call_segment_id}/dialingToCallSegments
Description	Provides access to all call segments the specified call segment is dialing. Information 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. Parameters: core_server_id: the id of the parent core server core_server_slug: the slug of the parent core server call_segment_id: the id of the parent call segment Errors: 404 Not Found: Returned if no core server with the given id or slug exists 404 Not Found: Returned if no user with the given id or username exists 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.
GET	Gets all call segments the specified call segment is dialing.

Instance Resource Paths

Paths used to access a specific instance of the resource.

{root_resource_path}/{call_segment_id}
Description	Provides access to a specified call segment, by call segment id. Information 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. Parameters: root_resource_path: One of the root resource paths for this resource. See Root Resource Paths above call_segment_id: the id of the call segment to access Errors: 404 Not Found: Returned if any of the ancestors in the root resource path could not be found 404 Not Found: Returned if no call segment with the specified call segment id could be found 403 Forbidden: Returned if any of the parents specified in the root resource path are restricted 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.
GET	Gets the specified call segment.

communication_manager/rest/live/coreServers/[{core_server_id} \| getByName/{core_server_slug}]/callSegments/{call_segment_id}/dialingFromCallSegment
Description	Provides access to the call segment that is dialing the specified call segment. Information 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. Parameters: root_resource_path: One of the root resource paths for this resource. See Root Resource Paths above call_segment_id: the id of the parent call segment Errors: 404 Not Found: Returned if any of the ancestors in the root resource path could not be found 404 Not Found: Returned if no call segment with the specified call segment id could be found 404 Not Found: Returned if the specified call segment is not being dialed by another call segment 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.
GET	Gets the call segment that is dialing the specified call segment.

communication_manager/rest/live/coreServers/[{core_server_id} \| getByName/{core_server_slug}]/callSegments/{call_segment_id}/linkedCallSegment
Description	Provides access to the call segment that the specified call segment is linked to. Information 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. Parameters: root_resource_path: One of the root resource paths for this resource. See Root Resource Paths above call_segment_id: the id of the parent call segment Errors: 404 Not Found: Returned if any of the ancestors in the root resource path could not be found 404 Not Found: Returned if no call segment with the specified call segment id could be found 404 Not Found: Returned if the specified call segment is not linked to another call segment 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.
GET	Gets the call segment that the specified call segment is linked to.

Action Paths

Actions that can be performed on this resource.

{instance_resource_path}/transfer

Description

Transfers the call segment, that is bound to the specified call segment.

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.

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.

For example:

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.

Parameters:

instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above

Errors:

404 Not Found: Returned if any of the ancestors in the instance resource path could not be found
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.
422 Unprocessable Entity: Returned if no destination number value was provided

422 Unprocessable Entity: Returned if no attended value was provided
422 Unprocessable Entity: Returned if the attended value provided is not a boolean value

JSON

{
"destinationNumber": "18005555555",
"attended" : false
}

Properties:

Property	Type	Description
destinationNumber	String	The number to transfer to.
attended	Boolean	Specifies if the transfer should be attended or not. Information Attended transfers should no be performed, if the call source is not an extension.

POST

Transfers the call segment, that is bound to the specified call segment.

{instance_resource_path}/kick

Description

Kicks the call segment from it's current conference room.

This action is only available in iSymphony 3.3+.
This action is only available on servers that have conference rooms enabled.

This action can only be performed on call segments that are in conference rooms.

Parameters:

instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above

Errors:

404 Not Found: Returned if any of the ancestors in the instance resource path could not be found
500 Internal Server Error: Returned if the specified call segment is not on a server with conference rooms enabled

{instance_resource_path}/mute

Description

Mutes the call segment in a conference room.

This action is only available in iSymphony 3.3+.
This action is only available on servers that have conference rooms enabled.

This action can only be performed on call segments that are in conference rooms.

Parameters:

instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above

Errors:

404 Not Found: Returned if any of the ancestors in the instance resource path could not be found
500 Internal Server Error: Returned if the specified call segment is not on a server with conference rooms enabled

{instance_resource_path}/unmute

Unmutes the call segment in the conference room.

This action is only available in iSymphony 3.3+.
This action is only available on servers that have conference rooms enabled.

This action can only be performed on call segments that are in conference rooms.

Parameters:

instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above

Errors:

404 Not Found: Returned if any of the ancestors in the instance resource path could not be found
500 Internal Server Error: Returned if the specified call segment is not on a server with conference rooms enabled

Curl Examples

Get all call segments in a core server

curl --user manager:manag3rpa55word -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4/callSegments

Get a specific call segment in a core server

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

Get all call segments owned by an extension

Get a specific call segment owned by an extension

Get all call segments a specified call segment is dialing

Get a specific call segment a specified call segment is dialing

Get the call segment that is dialing a specified call segment

Get the call segment linked to a specified call segment

Transfer the call segment the specified call segment is bound to

See notes in the transfer action path above, concerning which call segment to specify when performing a transfer action.

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

Kicks the specified call segment from it's conference room

curl --user manager:manag3rpa55word -i -H "Accept: application/json" -X POST http://localhost:58080/communication_manager/rest/live/coreServers/getByName/default/conferences/getByName/94868/callSegments/adaa2579-34bd-4073-aa69-e97eee46c38e/kicks

Call Segments

Description

JSON Representation

Root Resource Paths

Instance Resource Paths

Action Paths

Curl Examples

Get all call segments in a core server

Get a specific call segment in a core server

Get all call segments owned by an extension

Get a specific call segment owned by an extension

Get all call segments a specified call segment is dialing

Get a specific call segment a specified call segment is dialing

Get the call segment that is dialing a specified call segment

Get the call segment linked to a specified call segment

Transfer the call segment the specified call segment is bound to

Kicks the specified call segment from it's conference room

Mute the specified call segment in it's conference room

Unmutes the specified call segment in it's conference room

Search

Navigation