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 recording agent configuration REST resource allows access to the configuration for all recording agents connected to the server. This resource allows editing of the configuration of the connected recording agents.

On this page:

 

Root Resource Path

communication_manager/rest/config/asterisk/recordingAgents

JSON Representation

{
  "id": "fba22843-c7a0-408f-8c4f-8f37ccdba76c",
  "identifier": "local-rec",
  "rootPath": "\/var\/spool\/asterisk\/monitor",
  "fileNameMask": "${Tag(exten)}-${DstExtension}-${SrcExtension}-${Date(yyyyMMdd)}-${Time(HHmmss)}-${CDRUniqueId}",
  "resourceHost": "pbx.mydomain.com",
  "resourceExtension": "wav"
}
PropertyTypeDescription
id
String

Configuration id of the recording agent.

identifierStringThe unique identifier of the recording agent.
rootPathStringThe path on the server where the recording files are stored.
fileNameMask
StringFile name mask used to parse information out of the recording file names.
resourceHostStringThe host used to build the recording playback URLs for the client. Usually the publicly accessible IP or hostname of the phone system.
resourceExtension
StringFile extension of the recording files.

Resource Paths

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

Accesses a specific recording agent connected to the server.

Parameters:

  • agentIdentifier: The unique identifier of the agent.
GET

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

Errors:

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

Updates the configuration of the specified recording agent.

Errors:

  • 404 'A recording agent with the given identifier does not exist': Returned if no recording 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 recording agents connected to the server

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

Get the configuration for specific recording agent

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

Update a recording agent configuration

curl --user manager:manag3rpa55word -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X PUT -d '{"id":"fba22843-c7a0-408f-8c4f-8f37ccdba76c","identifier":"local-rec","rootPath":"/var/spool/asterisk/monitor","fileNameMask":"${Tag(exten)}-${DstExtension}-${SrcExtension}-${Date(yyyyMMdd)}-${Time(HHmmss)}-${CDRUniqueId}","resourceHost":"pbx.mydomain.com","resourceExtension":"wav"}' http://localhost:58080/communication_manager/rest/config/asterisk/recordingAgents/local-rec
  • No labels