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

Description

The Asterisk voicemail agent configuration REST resource allows access to the configuration for all voicemail agents connected to the server. This resource allows editing of the configuration of the connected voicemail agents.

On this page:

 

Root Resource Path

communication_manager/rest/config/asterisk/voicemailAgents

JSON Representation

{
  "id": "b3116fa0-ccf9-46c5-911e-3ab489565b74",
  "identifier": "local-vm",
  "rootPath": "\/var\/spool\/asterisk\/voicemail",
  "resourceHost": "pbx.mydomain.com",
  "resourceExtension": "wav"
}
PropertyTypeDescription
id
String

Configuration id of the voicemail agent.

identifierStringThe unique identifier of the voicemail agent.
rootPathStringThe path on the server where the voicemail files are stored.
resourceHostStringThe host used to build the voicemail playback URLs for the client. Usually the publicly accessible IP or hostname of the phone system.
resourceExtension
StringFile extension of the voicemail files.

Resource Paths

communication_manager/rest/config/asterisk/voicemailAgents
DescriptionAccesses all the voicemail agents connected to the server.
GET Gets the configuration for all the voicemail agents connected to the server.
 
communication_manager/rest/config/asterisk/voicemailAgents/{agentIdentifier}
Description

Accesses a specific voicemail agent connected to the server.

Parameters:

  • agentIdentifier: The unique identifier of the agent.
GET

Gets the configuration of the specified voicemail agent connected to the server.

Errors:

  • 404 'A voicemail agent with the given identifier does not exist': Returned if no voicemail agent exists with the given identifier.
PUT

Updates the configuration of the specified voicemail agent.

Errors:

  • 404 'A voicemail agent with the given identifier does not exist': Returned if no voicemail agent exists with the given identifier.
  • 412 'No rootPath provided.': Returned if no root path was provided.
  • 412 'No resourceHost provided.': Returned if no resource host was provided.
  • 412 'No resourceExtension provided.': Returned if no resource extension was provided.

Curl Examples

Get all voicemail agents connected to the server

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

Get the configuration for specific voicemail agent

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

Update a voicemail agent configuration

curl --user manager:manag3rpa55word -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X PUT -d '{"id":"b3116fa0-ccf9-46c5-911e-3ab489565b74","identifier":"local-vm","rootPath":"../misc-internals/conf/voicemail/backup","resourceHost":"pbx.mydomain.com","resourceExtension":"wav"}' http://localhost:58080/communication_manager/rest/config/asterisk/voicemailAgents/local-vm
  • No labels