Page tree
Skip to end of metadata
Go to start of metadata

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

Description

The live conference room REST resource allows access to the state information of conference rooms on a specified core server.

On this page:

 

 

 

JSON Representation

{
  "id":"c97be0d8-3c40-47c5-b8ee-868984b9d7f4",
  "configurationId":"066a6359-0ff1-49e5-83aa-52083dfbbddb",
  "displayName":"Main",
  "identifier":"650",
  "dialString":"650",
  "userGenerated":false,
  "permissionId":"066a6359-0ff1-49e5-83aa-52083dfbbddb"
}
PropertyTypeDescription
id

String

The id of the conference room.

configurationId

String

The id of the configuration object that represents the conference room.

displayName

String

The display name of the conference room.

identifier

String

The identifier of the conference room.

dialString

String

The string used to dial a conference room.

userGenerated

Boolean

True if the conference room is user generated, else false.

permissionId

String

The conference rooms permission id.

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}]/conferences
Description

Provides access to all conference rooms on the specified core server.

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
GETGets all conference rooms on a core server.

Instance Resource Paths

Paths used to access a specific instance of the resource.

{root_resource_path}/{conference_room_id}
Description

Provides access to a specific conference room, by a conference room id.

Parameters:

  • root_resource_path: One of the root resource paths for this resource. See Root Resource Paths above
  • conference_room_id: the id of the conference room 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 conference room with the given id exists
GETGets the specified conference room.
{root_resource_path}/getByName/{conference_room_identifier}
Description

Provides access to a specific conference room, by a conference room identifier.

Parameters:

  • root_resource_path: One of the root resource paths for this resource. See Root Resource Paths above
  • conference_room_identifier: the identifier of the conference room 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 conference room with the given conference room identifier exists
GETGets the specified conference room.

Sub Resource Paths

Paths used to access the child resources of this resource.

{instance_resource_path}/callSegments
Description

Provides access to all call segments in the specified conference room. See Call Segments.

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 any of the ancestors in the instance resource path could not be found
GET Gets all call segments in the specified conference room.

Curl Examples

Get all conference rooms

curl --user manager:manag3rpa55word -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/live/coreServers/c36544a7-aefc-4e96-92af-2fca93c18c0b/conferences

Get a specific conference room

curl --user manager:manag3rpa55word -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/live/coreServers/c36544a7-aefc-4e96-92af-2fca93c18c0b/conferences/c97be0d8-3c40-47c5-b8ee-868984b9d7f4
  • No labels