Core Servers

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+.

Description

The live core server REST resource allows access to information about a core server. There are currently no actions that can be performed on a core server. This resource simply serves as a parent resource to access other sub/child resources.

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": "11de1781-b239-4ced-bd24-7b06d4c9956b",
"slug": "default",
"name": "default"
}

Property	Type	Description
id	String	The id of the core server.
slug	String	The directory slug of the core server.
name	String	The display name of the core server.

Root Resource Paths

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

communication_manager/rest/live/coreServers
Description	Accesses the state of all core servers in the system.
GET	Gets all core servers in the system.

Instance Resource Paths

Paths used to access a specific instance of the resource.

{root_resource_path}/{core_server_id}
Description	Provides access to a specified core server, by core server id. Parameters: root_resource_path: One of the root resource paths for this resource. See Root Resource Paths above core_server_id: the id of the core server to access Errors: 404 Not Found: Returned if no core server with the given id exists
GET	Gets the specified core server.

{root_resource_path}/getByName/{core_server_slug}
Description	Provides access to a specified core server, by core server slug. Parameters: root_resource_path: One of the root resource paths for this resource. See Root Resource Paths above core_server_slug: the slug of the core server to access Errors: 404 Not Found: Returned if no core server with the given slug exists
GET	Gets the specified core server.

Sub Resource Paths

Paths used to access the child resources of this resource.

{instance_resource_path}/users
Description	Provides access to all users in the specified core server. See Users. 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
GET	Gets all users in the specified core server.

{instance_resource_path}/extensions
Description	Provides access to all extensions in the specified core server. See Extensions. Information Excludes any extensions that are not bound to a licensed/full user. 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
GET	Gets all extension in the specified core server.

{instance_resource_path}/queues
Description	Provides access to all queues in the specified core server. See Queues. Information Excludes any queues that are not enabled. Parameters: instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above Errors: 404 Not Found: Returned if no core server with the given id or slug exists
GET	Gets all queues in the specified core server.

{instance_resource_path}/callSegments
Description	Provides access to all call segments in the specified core server. See Call Segments. 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: instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above Errors: 404 Not Found: Returned if no core server with the given id or slug exists
GET	Gets all call segment in the specified core server.

Curl Examples

Get all core servers

curl --user manager:manag3rpa55word -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/live/coreServers

Get a specific core server

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