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

Description

The Asterisk conference room REST resource allows access to the configuration for conference rooms in the system. This resource allows adding, removing, and updating of conference rooms in the system.

 

On this page:

 

Root Resource Path

communication_manager/rest/config/asterisk/{coreServerId}/conferenceRooms

JSON Representation

{
  "id": "066a6359-0ff1-49e5-83aa-52083dfbbddb",
  "name": "Main",
  "identifier": "650",
  "destinationExtension": "650",
  "destinationContext": "from-internal",
  "permissionDisplayName": "Main <650>",
  "permissionId": "066a6359-0ff1-49e5-83aa-52083dfbbddb"
}
PropertyTypeDescription
id
String

Configuration id of the conference room.

name
StringThe display name of the conference room.
identifierStringThe Asterisk identifier of the conference room.
destinationExtension
StringThe extension used to call the conference room from the panel.
destinationContext
StringThe context used to call the conference room from the panel.
displayNameStringThe display name for the user.
permissionDisplayName
StringDisplay name of the conference room in the permission system.
permissionId
StringPermission id of the conference room.

Resource Paths

communication_manager/rest/config/asterisk/{coreServerId}/conferenceRooms
DescriptionAccesses all the conference rooms in the core server.
GET Gets all the configuration for all the conference rooms in the system.
POST

Adds a conference room to the configuration.

Errors:

  • 409 'A conferenceRoom with the given id already exists.': Returned if a conference room with the given id already exists.
  • 409 'A conferenceRoom with the given identifier already exists.': Returned if a conference room with the given identifier already exists.
  • 412 'No identifier provided.': Returned if no identifier was provided.
  • 412 'No name provided.': Returned if no name was provided.
  • 412 'No destinationContext provided.': Returned if no destination context was provided.
  • 412 'No destinationExtension provided.': Returned if no destination extension was provided.
 
communication_manager/rest/config/asterisk/{coreServerId}/conferenceRooms/{conferenceRoomId}
Description

Accesses the configuration of a specific conference room.

Parameters:

  • conferenceRoomId: The configuration id of the conference room.
GET

Gets the configuration of the specified conference room.

Errors:

  • 404 'A conference room with the given id does not exist': Returned if no conference room exists with the given id.
PUT

Updates the specified conference room configuration.

Errors:

  • 404 'A conference room with the given id does not exist': Returned if no conference room exists with the given id.
  • 409 'A conference room with the given identifier already exists.': Returned if a conference room with the given identifier already exists.
  • 412 'No identifier provided.': Returned if no identifier was provided.
  • 412 'No name provided.': Returned if no name was provided.
  • 412 'No destinationContext provided.': Returned if no destination context was provided.
  • 412 'No destinationExtension provided.': Returned if no destination extension was provided.
DELETE

Deletes the specified conference room configuration.

Errors:

  • 404 'A queue with the given id does not exist': Returned if no queue exists with the given id.

Curl Examples

Get all conference rooms in a core server

curl --user manager:manag3rpa55word -k -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/config/asterisk/ee828da8-5ee6-412d-82ac-1273f598659d/conferenceRooms

Get the configuration for a specific conference room

curl --user manager:manag3rpa55word -k -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/config/asterisk/ee828da8-5ee6-412d-82ac-1273f598659d/conferenceRooms/56cf70a3-1ee0-4b09-8f40-297430eeeddf

Add a new conference room

curl --user manager:manag3rpa55word -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d '{"id":"066a6359-0ff1-49e5-83aa-52083dfbbddb","name":"Main","identifier":"650","destinationExtension":"650","destinationContext":"from-internal"}' http://localhost:58080/communication_manager/rest/config/asterisk/ee828da8-5ee6-412d-82ac-1273f598659d/conferenceRooms

Delete a conference room

curl --user manager:manag3rpa55word -k -i -X DELETE http://localhost:58080/communication_manager/rest/config/asterisk/ee828da8-5ee6-412d-82ac-1273f598659d/conferenceRooms/56cf70a3-1ee0-4b09-8f40-297430eeeddf

Update a conference room

curl --user manager:manag3rpa55word -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X PUT -d '{"id":"066a6359-0ff1-49e5-83aa-52083dfbbddb","name":"Main New","identifier":"650","destinationExtension":"650","destinationContext":"from-internal"}' http://localhost:58080/communication_manager/rest/config/asterisk/ee828da8-5ee6-412d-82ac-1273f598659d/conferenceRooms/56cf70a3-1ee0-4b09-8f40-297430eeeddf
  • No labels