Asterisk Voicemail Agent Configuration

Last modified by ryanp on 2021/09/10 23:34

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:

The [toc] macro is a standalone macro and it cannot be used inline. Click on this message for details.
This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it.

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"
}

Property	Type	Description
id	String	Configuration id of the voicemail agent.
identifier	String	The unique identifier of the voicemail agent.
rootPath	String	The path on the server where the voicemail files are stored.
resourceHost	String	The host used to build the voicemail playback URLs for the client. Usually the publicly accessible IP or hostname of the phone system.
resourceExtension	String	File extension of the voicemail files.

Resource Paths

communication_manager/rest/config/asterisk/voicemailAgents
Description	Accesses 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