Core Server Voicemail Agent Configuration

Version 3.1 by michaely on 2016/05/30 21:41

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.

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 core server voicemail agent REST resource allows access to the list of voicemail agents that are bound to the core server. This resource allows binding and unbinding voicemail agents to and from core servers.

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/{coreServerId}/voicemailAgentIdentifiers

JSON Representation

"local-vm"

Resource Paths

communication_manager/rest/config/asterisk/{coreServerId}/voicemailAgentIdentifiers
Description	Accesses all the list of voicemail agent identifiers bound to the core server.
GET	Gets all the list of voicemail agent identifiers bound to the core server.
POST	Adds a specific voicemail agent as a bound agent on the core server.

communication_manager/rest/config/asterisk/{coreServerId}/voicemailAgentIdentifiers/{voicemailAgentIdentifier}
Description	Access a specific bound voicemail agent identifier. Parameters voicemialAgentIdentfier: The identifier of the voicemail agent.
DELETE	Removes a specific voicemail agent as a bound agent on the core server.

Curl Examples

Get all bound voicemail agent identifiers

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

Add a bound voicemail agent identifier

curl --user manager:manag3rpa55word -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d '"server2-vm"' http://localhost:58080/communication_manager/rest/config/asterisk/ee828da8-5ee6-412d-82ac-1273f598659d/voicemailAgentIdentifiers

Remove a bound voicemail agent identifier

curl --user manager:manag3rpa55word -k -i -X DELETE http://localhost:58080/communication_manager/rest/config/asterisk/ee828da8-5ee6-412d-82ac-1273f598659d/voicemailAgentIdentifiers/server2-vm