Skip to Content

Asterisk Extension Group Configuration

Version 5.1 by michaely on 2016/05/31 14:05
Warning
For security reasons, the document is displayed in restricted mode as it is not the current version. There may be differences and errors due to this.
Warning

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

Information

The information on this page applies to iSymphony 3.1+.

Description

The Asterisk extension group configuration REST resource allows access to the configuration for extension groups in the system. This resource allows adding, removing, and updating of extension groups in the system.

 

On this page:

The [toc] macro is a standalone macro and it cannot be used inline. Click on this message for details.
 

Root Resource Path

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

JSON Representation

{
 "id": "6faafc58-9e7d-461e-a3ab-de6e5fce6dee",
 "displayName": "Not So Famous",
 "publicGroup": true
}

Property

Type

Description

id

String

Configuration id of the extension group.

displayName

String

The display name of the extension group.

publicGroup

Boolean

Flag specifying if the extension group is public or not.

Resource Paths

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

Description

Accesses all the extension groups in the core server.

GET 

Gets the configuration for all the extension groups in the core server.

POST

Adds a extension group to the configuration.

Errors:

  • 409 'An extension group with the given id already exists.': Returned if an extension group with the given id already exists.
  • 409 'An extension with the given displayName already exists.': Returned if an extension group with the given display name already exists.
  • 412 'No displayName provided.': Returned if no display name was provided.

 

communication_manager/rest/config/asterisk/{coreServerId}/extensionGroups/{extensionGroupId}

Description

Accesses the configuration of a specific extension group.

Parameters:

  • extensionGroupId: The configuration id of the extension group.

GET

Gets the configuration of the specified extension group.

Errors:

  • 404 'An extension group with the given id does not exist': Returned if no extension group exists with the given id.

PUT

Updates the specified extension group configuration.

Errors:

  • 404 'An extension group with the given id does not exist': Returned if no extension group exists with the given id.
  • 409 'An extension with the given displayName already exists.': Returned if an extension group with the given display name already exists.
  • 412 'No displayName provided.': Returned if no display name was provided.

DELETE

Deletes the specified extension group.

Errors:

  • 404 'An extension group with the given id does not exist': Returned if no extension gropu exists with the given id.

Sub/Child Resource Paths

communication_manager/rest/config/core/{coreServerId}/extensionGroups/{extensionGroupId}/extensions

Description

Access the sub/child resource for the extensions that belong to this group.

Parameters:

  • extensionGroupId: The configuration id of the extension group.

Errors:

  • 404 'An extension group with the given id does not exist': Returned if no extension group exists with the given id.

 

communication_manager/rest/config/core/{coreServerId}/extensionGroups/{extensionGroupId}/users

Description

Accesses the sub/child resource for the users who's extensions are part of this group.

Parameters:

  • extensionGroupId: The configuration id of the extension group.

Errors:

  • 404 'An extension group with the given id does not exist': Returned if no extension group exists with the given id.

 

communication_manager/rest/config/core/{coreServerId}/extensionGroups/{extensionGroupId}/viewers

Description

Accesses the sub/child resource for the users who are marked as viewers of the extension group.

Parameters:

  • extensionGroupId: The configuration id of the extension group.

Errors:

  • 404 'An extension group with the given id does not exist': Returned if no extension group exists with the given id.

 

communication_manager/rest/config/core/{coreServerId}/extensionGroups/{extensionGroupId}/editors

Description

Accesses the sub/child resource for the users who are marked as editors of the extension group.

Parameters:

  • extensionGroupId: The configuration id of the extension group.

Errors:

  • 404 'An extension group with the given id does not exist': Returned if no extension group exists with the given id.

Curl Examples

Get all extension groups in a core server

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

Get the configuration for a specific extension group

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

Add a new extension group

curl --user manager:manag3rpa55word -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d '{"id":"6faafc58-9e7d-461e-a3ab-de6e5fce6dee","displayName":"Not So Famous","publicGroup":true},{"id":"3cd3e767-e9c6-4589-a7dc-9a431312611f","displayName":"Famous People","publicGroup":true}' http://localhost:58080/communication_manager/rest/asterisk/ee828da8-5ee6-412d-82ac-1273f598659d/extensionGroups

Delete an extension group

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

Update an extension group

curl --user manager:manag3rpa55word -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X PUT -d '{"id":"c46f4e60-aba2-4340-a6a5-0c7304d40ba1","displayName":"Not So Famous","publicGroup":false},{"id":"3cd3e767-e9c6-4589-a7dc-9a431312611f","displayName":"Famous People","publicGroup":true}' http://localhost:58080/communication_manager/rest/asterisk/ee828da8-5ee6-412d-82ac-1273f598659d/extensionGroup/c46f4e60-aba2-4340-a6a5-0c7304d40ba1