Recording Service - Getting Started
Download OpenAPI specification:Download
At Your Side:
Ensure SIPRec Support in Your Telephony System
Confirm that your PBX or Session Border Controller (SBC) supports the SIPRec protocol. This is essential for initiating call recordings, as the system must send SIPRec INVITE requests to the iotcomms.io Session Recording Server (SRS).Configure Network and Firewall Settings
Set up your network to route SIPRec traffic to the iotcomms.io platform. Configure your firewall to allow SIP signaling and media traffic. Ensure proper DNS configuration to resolve SIPRec hostnames as per RFC 3263. Open ports for RTP media streams to enable seamless communication.Generate API Keys
Obtain API keys or tokens to securely authenticate with the iotcomms.io platform. These keys are used to manage call recordings, including starting, stopping, storing, and deleting them through the SIPRec API.Set Up Callback URLs
Configure HTTPS callback endpoints to receive real-time event notifications, such as RECORDINGSTARTED, RECORDINGREADY, and RECORDINGSTORED. Ensure your application can process these callbacks to maintain proper workflow.Set Up Final Storage
Create an Amazon S3 bucket or configure an S3-compatible on-premise storage solution for storing recordings. Ensure necessary permissions, access keys, and encryption policies are in place. This destination will be referenced in the STORERECORDING command for secure and compliant storage of call recordings.
Provisioning the Recording Service:
Configure Telephony Systems
Use the SIPRec interface to connect your PBX or SBC to the iotcomms.io Session Recording Server. This includes enabling the SIPRec protocol and ensuring that the SRC (Session Recording Client) sends SIPRec INVITEs for call recordings.Set Up Application REST Callback Endpoint
Configure your application to handle REST callbacks from the iotcomms.io platform. This ensures your application can respond to events such as RECORDINGSTARTED, RECORDINGREADY, and RECORDINGSTORED.
Testing the Recording Service:
Initiate a Test Recording
Generate a SIPRec INVITE request from your telephony system to the iotcomms.io SRS. Verify that the RECORDINGSTARTED callback is received and the recording is successfully captured.Validate Recording Storage
Send a STORERECORDING API command to transfer the recording from temporary storage to your designated storage location. Confirm the receipt of the RECORDINGSTORED callback and verify the file in the storage bucket.Check Callbacks and Logs
Use the iotcomms.io developer portal to review event logs. Ensure that all expected callbacks (e.g., RECORDINGREADY, RECORDINGFAILED) are logged correctly and match the intended actions in your application workflow.