Recording Service - API Overview

This API overview provides a detailed summary of tools for provisioning, managing, and integrating the iotcomms.io Recording Service, enabling robust recording management, advanced control of recorded sessions, and real-time event-driven application integration.

1. Service Provisioning API

   The Service Provisioning API is essential for setting up and configuring the Recording Service for your domain. This API allows you to define callback URLs for alarms and events, configure SIPRec settings, and ensure seamless integration with your telephony infrastructure. Setting up the service through this API establishes the foundation for recording, managing, and storing call data.

   • PUT /notificationsettings/{domain}

     Configures destinations for service alarms and REST callbacks to handle real-time notifications from the service.

   • PUT /siprecservice/{domain}

     Sets up SIPRec-specific configurations, including the SIPRec interface and related settings for the recording service.

2. APIs for Application Integration

   These APIs provide the capability to manage and control recordings dynamically, including starting, stopping, canceling, and storing recordings, as well as merging related files into cohesive recordings. They enable flexible and precise workflows tailored to meet application needs.

   • POST /{domain}/cancelrecording

     Cancels an ongoing recording session and removes any temporary files created.

   • POST /{domain}/deleterecording

     Deletes a recording file permanently from storage.

   • POST /{domain}/stoprecording

     Ends an active recording session and finalizes the recording file.

   • POST /{domain}/storerecording

     Transfers a recording file from temporary storage to permanent storage with options for masking and trimming.

   • POST /{domain}/mergerecordings

     Merges multiple related recordings into a single file for simplified playback and storage.

3. REST Callbacks for Application Integration

   These REST callbacks provide event-driven notifications that enable your application to stay updated on the recording lifecycle in real time. Handling these callbacks ensures timely responses to recording events, automating workflows and integrating seamlessly into your application processes.

   • POST /newCall

     Triggered when a new SIPRec session is initiated, allowing the application to decide whether to record the call.

   • POST /recordingStarted

     Notifies the application that a recording session has successfully started.

   • POST /recordingFailed

     Sent when a recording session encounters an error, providing details about the failure.

   • POST /recordingCancelled

     Indicates that a recording session was canceled, either by application request or system action.

   • POST /recordingReady

     Alerts the application that a recording is complete and ready for further processing or storage.

   • POST /recordingsMerged

     Confirms that related recordings have been successfully merged into a single file.

4. SNS Events and SQS Commands for Application Integration

   For applications running in an AWS environment, the Recording Service also offers corresponding **SNS events**and **SQS commands** as alternatives to REST APIs and callbacks. These options simplify integration with AWS-native workflows and provide a seamless method for managing events and commands.

   • SNS Events

     These notifications are automatically sent to an Amazon SNS topic, allowing applications to receive and process updates in real time without polling. Corresponding events include:

     • RECORDINGSTARTED

     • RECORDINGREADY

     • RECORDINGFAILED

     • RECORDINGCANCELLED

     • RECORDINGSTORED

     • RECORDINGSMERGED

   • SQS Commands

     These commands are sent to an Amazon SQS queue, enabling applications to interact with the service by issuing commands directly via SQS. Supported commands include:

     • STOPRECORDING

     • CANCELRECORDING

     • STORERECORDING

     • MERGERECORDINGS

The SNS events and SQS commands are excellent options for customers developing applications in an AWS environment, as they leverage AWS's native messaging infrastructure for improved reliability, scalability, and operational simplicity.

These APIs, callbacks, SNS events, and SQS commands offer a comprehensive and flexible toolkit for managing the Recording Service, enabling robust integration with applications while supporting diverse deployment environments and workflows.