Monitor Recordings

Aculab cloud has a facility to record all the incoming audio received from outbound calls placed by your applications, starting from any early media received before the call is answered.

This is useful for debugging problems with calling specific phone numbers - for example Live Speaker Detection misclassification, or hearing the announcement explaining why calls to a number are being rejected, perhaps because the number has changed.

A Monitor Recording is substantially different to a Call Recording (enabled on the service configuration) as it records only inbound audio on outbound calls and the recorded file is not available in the Media File Store. This document describes the web services that can be used to list Monitor recordings for a given application instance, and download them.

Note

 Please note that as this is a debug facility, it is not enabled by default on Aculab Cloud accounts. Please contact us if you would like us to enable it for you.

Note

 This is a low level API. For information on higher level APIs see the Web Services Language Wrappers

Authorisation

This API uses basic authentication, using your cloud account username and API Access Key.

Username	: cloudID/username (e.g. 1-2-0/bob@example.com)
Password	: API Access Key

Monitor List

This lists the filenames of monitor recordings created for the given application instance id. There will be one file for each outbound call placed by the application for which any media was received. Please note that these files are kept for approximately two weeks before being deleted.

Request

URL	: https://ws-[cloudID].aculabcloud.net/monitor_list
Methods	: GET, POST

Parameter	Value	Description
application_instance_id	string	an application instance id.

Response

Returns a JSON object containing a dictionary of the filenames and their properties.

Parameter	Value	Description
created_date	string	a string representing the time that the file was created in UTC.
size	integer	the size of the file in bytes.

Example

Request

https://ws-[cloudID].aculabcloud.net/monitor_list?application_instance_id=0123456789abcdef.12345

Response

  {
    "2014-05-14/0123456789abcdef.12345.6543/150994965_NRCH_NORMAL(200).wav":
    {
      "created_date": "2014-05-14_00:02:09",
      "size": 1202290
    }
  } 

Monitor Get

Fetches the specified monitor recording file, using a filename discovered by use of monitor_list.

Note

Please note that these files are kept for approximately two weeks before being deleted.

Request

URL	: https://ws-[cloudID].aculabcloud.net/monitor_get
Methods	: GET, POST

Parameter	Value	Description
filename	string	a monitor recording filename as returned by Monitor List.

Response

The contents of the monitor file. This is a RIFF-encoded WAV audio file.

Example

Request

https://ws-[cloudID].aculabcloud.net/monitor_get?filename=2014-05-14/0123456789abcdef.12345.6543/150994965_NRCH_NORMAL(200).wav