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

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Current »

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 core server configuration REST resource allows access to the top level Asterisk specific configuration for a core server. This resource allows modification of the top level Asterisk configuration for a core server. 

 

On this page:

 

Root Resource Path

communication_manager/rest/config/asterisk

JSON Representation

{
  "id": "ff2e69f0-01eb-43b0-a8cd-de47e0674229",
  "serverId": "fe205631-d5f8-4e88-9698-0e5a645e6bca",
  "tenantId": "",
  "ringStatusEnabled": true,
  "pageStatusEnabled": true,
  "confBridge": true,
  "originatingContext": "from-internal",
  "redirectingContext": "from-internal",
  "musicOnHoldClass": "default",
  "originateTimeout": 30000
}
PropertyTypeDescription
id
String

Configuration id of the top level Asterisk configuration object.

serverIdStringThe core server id the Asterisk configuration is for.
tenantIdStringThe tenant id of the core server.
ringStatusEnabledBooleanFlag specifying if ringing status should be shown or not. Not currently used.
pageStatusEnabled
BooleanFlag specifying if page status should be shown or not. Not currently used.
confBridgeBooleanFlag specifying if app_confbridge is used for dynamic conferences or not.
originatingContext
StringEntry point dialplan context for all call originations made in the panel.
redirectingContext
StringEntry point dialplan context for all call transfers made in the panel.
musicOnHoldClass
StringMusic on hold class used when placing calls on hold in the panel.
originateTimeout
StringNumber of milliseconds to ring the origination extension when making a new call in the panel, before timing out.

Resource Paths

communication_manager/rest/config/asterisk
DescriptionAccesses the top level Asterisk configuration for all core servers.
GET Gets the top level Asterisk configuration for all core servers.
 
communication_manager/rest/config/asterisk/{coreServerId}
Description

Accesses the top level Asterisk configuration for a specific core server.

Parameters:

  • coreServerId: The core server id.
GET

Gets the top level Asterisk configuration for a specific core server.

Errors:

  • 404 'Failed to locate the core server with the given id': Returned if no core server exists with the given id.
PUT

Updates the top level Asterisk configuration.

Errors:

  • 404 'Failed to locate the core server with the given id': Returned if no core server exists with the given id.
  • 412 'No originatingContext provided.': Returned if no originating context was provided.
  • 412 'No redirectingContext provided.': Returned if no redirecting context was provided.
  • 412 'No musicOnHoldClass provided.': Returned if not music on hold class was provided.

Sub/Child Resource Paths

communication_manager/rest/config/asterisk/{coreServerId}/pbxServers
Description

Access the sub/child resource for the PBX server connections.

Parameters:

  • coreServerId: The id of the core server.

Errors:

  • 404 'Failed to locate the core server with the given id': Returned if no core server exists with the given id.

See Asterisk PBX Server Configuration for more information.

 
communication_manager/rest/config/asterisk/{coreServerId}/extensions
Description

Access the sub/child resource for extensions.

Parameters:

  • coreServerId: The id of the core server.

Errors:

  • 404 'Failed to locate the core server with the given id': Returned if no core server exists with the given id.

See Asterisk Extension Configuration for more information.

 
communication_manager/rest/config/asterisk/{coreServerId}/queues
Description

Access the sub/child resource for queues.

Parameters:

  • coreServerId: The id of the core server.

Errors:

  • 404 'Failed to locate the core server with the given id': Returned if no core server exists with the given id.

See Asterisk Queue Configuration for more information.

 
communication_manager/rest/config/asterisk/{coreServerId}/parkingLots
Description

Access the sub/child resource for parking lots.

Parameters:

  • coreServerId: The id of the core server.

Errors:

  • 404 'Failed to locate the core server with the given id': Returned if no core server exists with the given id.

See Asterisk Parking Lot Configuration for more information.

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

Access the sub/child resource for conference rooms.

Parameters:

  • coreServerId: The id of the core server.

Errors:

  • 404 'Failed to locate the core server with the given id': Returned if no core server exists with the given id.

See Asterisk Conference Room Configuration for more information.

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

Access the sub/child resource for extension groups.

Parameters:

  • coreServerId: The id of the core server.

Errors:

  • 404 'Failed to locate the core server with the given id': Returned if no core server exists with the given id.

See Asterisk Extension Group Configuration for more information.

 
communication_manager/rest/config/asterisk/{coreServerId}/voicemailAgentIdentifiers
Description

Access the sub/child resource for extension groups.

Parameters:

  • coreServerId: The id of the core server.

Errors:

  • 404 'Failed to locate the core server with the given id': Returned if no core server exists with the given id.

See Asterisk Core Server Voicemail Agent Configuration for more information.

 
communication_manager/rest/config/asterisk/voicemailAgents
Description

Access the sub/child resource for the voicemail agents connected to the system.

 
communication_manager/rest/config/asterisk/recordingAgents
DescriptionAccess the sub/child resource for the recording agents connected to the system.

Curl Examples

Get the top level Asterisk configuration for all core servers

curl --user manager:manag3rpa55word -k -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/config/asterisk

Get the top level Asterisk configuration for a specific core server

curl --user manager:manag3rpa55word -k -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/config/asterisk/56cf70a3-1ee0-4b09-8f40-297430eeeddf

Update the top level Asterisk configuration

curl --user manager:manag3rpa55word -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X PUT -d '{"id":"ff2e69f0-01eb-43b0-a8cd-de47e0674229","serverId":"56cf70a3-1ee0-4b09-8f40-297430eeeddf","tenantId":"","ringStatusEnabled":true,"pageStatusEnabled":true,"confBridge":true,"originatingContext":"from-internal","redirectingContext":"from-internal","musicOnHoldClass":"default","originateTimeout":30000}' http://localhost:58080/communication_manager/rest/config/asterisk/56cf70a3-1ee0-4b09-8f40-297430eeeddf
  • No labels