Recording calls

Control recording of calls with the Sinch platform, with callbacks or the Manage Call API.

Overview

With the Sinch platform, you’re able to control the recording of the calls using either the callbacks or the Manage Call API.

Call recording

There are multiple ways to start call recording:

Using the Manage Call API
Sending the StartRecording instruction as part of a callback response
Setting the recording flag to true in the Action of the SVAML, during a callback response

In every case, the Recording Options are required to specify the details about the recording.

Conference recording

Conference recording can be enabled by either setting the recording flag in the ConnectConf action to true in the callback response (ICE/ACE) or by using the Conference API.

Note that there is a difference between conference and call recording. Every participant in a conference has an associated callId which can be used to start recording for that specific call. The recording file will contain the mix from the conference that was sent to that channel. However, once that participant leaves the conference, the recording is finished. Conference recording on the other hand, ends when all the participants leave the room, or when the platform receives a command to stop recording.

Also note that using the StartRecording instruction will start a call recording, even when used with the ConnectConf action. Recording instructions are only used for call recording.

Recording instructions

StartRecording
StopRecording

Format:

Copy

Copied

{
    "name": "StartRecording",
    "options": [RecordingOptions]
}

{
    "name": "StopRecording"
}

Using instructions brings more flexibility in what parts of the call should be recorded. For example, you might want to skip the first part of a Text-To-Speech instruction that was played, but want to include the next. Let’s say we've this SVAML response to an ICE callback:

Copy

Copied

{
    "instructions": [{
        "name": "Say",
        "text": "Hello world, I don't want you to record this part",
        "locale": "en-US"
    }, {
        "name": "StartRecording",
        "options": [...]
    }, {
        "name": "Say",
        "text": "Hello world, this part will be recorded",
        "locale": "en-US"
    }],
    "action": {
        ...
    }
}

In this example, the recording starts after the first Say instruction is finished executing, so the second part will be included in the recording file.

info

The StartRecording and StopRecording Instructions are not supported with ConnectMxp Action.

Recording options

The recording options are sent as part of the callback response when you want to enable recording of a call or a conference.

Copy

Copied

[RecordingOptions]
string - destinationUrl
string - credentials
string - format
bool - notificationEvents
object - [transcriptionOptions]: {
        bool    - enabled,
        string  - locale
        }

example ACE response

Copy

Copied

{
  "action": {
    "name": "Continue",
    "record": true,
    "recordingOptions": {
      "destinationUrl": "s3://my-s3-bucket",
      "credentials": "xyz_access_key:wrt_secret_key:eu-central-1",
      "format": "mp3",
      "notificationEvents": true,
      "transcriptionOptions": {
        "enabled": true,
        "locale": "en-US"
      }
    }
  }
}

Property	Description
destinationUrl	Where the recording file should be stored. Sinch supports the following destinations: Amazon S3 Microsoft Azure Blob Storage Google Cloud Storage To read more about how to configure each of these destinations, see the DestinationURL section.
credentials	Specifies the information required for the Sinch platform to authenticate and/or authorize in the destination service in order to be able to store the file.
format	An optional property that specifies the format of the recording file. Default value is `mp3`.
notificationEvents	An optional property that specifies if Sinch should send your backend events when the call recording is finished and when the file is available in the destination URL specified. For more information about notification events, see the Notification Events section. Default value is “true”

DestinationURL

This property is a URI and specifies where the recording file should be stored. Sinch supports multiple platforms for storage and will continue to enable new in the future:

Amazon S3
Microsoft Azure Blob Storage
Google Cloud Storage

Note: User can, but you don’t have to specify the filename in the destination. If there is no filename specified in the URI, Sinch will generate a unique name with the following format: (UTCDateyyyyMMddHHmmss)\(applicationKey)_(callId).(format)

Note: Sinch doesn't check if a filename exists in the specified path and will overwrite any existing file with the same filename.

DestinationURL: Amazon S3

Using the recordingOptions property, you can direct the Sinch platform to store the recording file to an Amazon S3 bucket. The destinationUrl property should be specified with a s3 schema, followed by the bucket name and optionally destination folder and file:

s3://bucket_name/[[folder]/[file]]

Using the Amazon S3 as a destination requires that the credentials be specified. The format of the credentials is defined with:

(AwsAccessKey):(AwsSecretKey):(AwsRegion)

Example

Copy

Copied

{
  "recordingOptions": {
    "destinationUrl": "s3://sinch-storage/voice-recordings/my-recording.mp3",
    "credentials": "AKIAIOSFODNN7EXAMPLE:wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY:eu-central-1",
    "notificationEvents": true
  }
}

Svaml action example

Copy

Copied

{
"action": {
   "name": "connectPstn",
   ...
   "recordingOptions": {
      "destinationUrl": "s3://sinch-storage/voice-recordings/my-recording.mp3",
    "credentials": "KEY:SECRET:aws_region",
      "notificationEvents": true
      }
    }
}

Svaml instruction example

Copy

Copied

{
    "instructions": [{
        "name": "startRecording",
        "options": {
            "destinationUrl": "s3://sinch-storage/voice-recordings/my-recording.mp3",
            "credentials": "KEY:SECRET:aws_region",
            "notificationEvents": true
            }
        }],
    "action": {
        "name": "connectPstn"
        ...
        }
}

Note: It's recommended that the credentials you specify authorize the Sinch platform to only write to the destination bucket. Sinch will never request read permissions.

DestinationURL: Microsoft Azure Blob Storage

To store your recordings to a Microsoft Azure Blob Storage container, use the azure schema identifier in the destinationUrl:

Copy

Copied

azure://account_name/container_name/file.ext

You must also provide the access key in the credentials property.

Example

Copy

Copied

{
  "recordingOptions": {
    "destinationUrl": "azure://my-account/test-container/my-recording.mp3",
    "credentials": "AAECAwQFBgcICQoLDA0ODxAREhMUFRYXGBkaGxwdHh8gISIjJCUmJygpKissLS4vMDEyMzQ1Njc4OTo7PD0+Pw==",
    "notificationEvents": true
  }
}

Svaml action example

Copy

Copied

{
    "action": {
        "name": "connectPstn",
    ...
        "recordingOptions": {
            "destinationUrl": "azure://my-account/test-container/my-recording.mp3",
            "credentials": "AAECAwQFBgcICQoLDA0ODxAREhMUFRYXGBkaGxwdHh8gISIjJCUmJygpKissLS4vMDEyMzQ1Njc4OTo7PD0+Pw==",
            "notificationEvents": true
            }
        }
}

Svaml instruction example

Copy

Copied

{
    "instructions": [{
        "name": "startRecording",
        "options": {
            "destinationUrl": "azure://my-account/test-container/my-recording.mp3",
            "credentials": "AAECAwQFBgcICQoLDA0ODxAREhMUFRYXGBkaGxwdHh8gISIjJCUmJygpKissLS4vMDEyMzQ1Njc4OTo7PD0+Pw==",
            "notificationEvents": true
            }
        }],
    "action": {
        "name": "connectPstn"
        ...
        }
}

DestinationURL: Google Cloud Storage

Using the recordingOptions property, you can direct the Sinch platform to store the recording file to an GCP Storage bucket. The destinationUrl property should be specified with a gs schema, followed by the bucket name and optionally destination folder and file:

gs://bucket_name/[[folder]/[file]]

Using the Google Cloud Storage as a destination requires that the credentials be specified. The format of the credentials is defined with:

(Access_key):(Secret) Cloud Storage Interoperability key and secret must be used.

See GCP Console link

Example

Copy

Copied

{
  "recordingOptions": {
    "destinationUrl": "gs://sinch-storage/voice-recordings/my-recording.mp3",
    "credentials": "ACCESS_KEY:SECRET",
    "notificationEvents": true
  }
}

Svaml action example

Copy

Copied

{
"action": {
   "name": "connectPstn",
   ...
   "recordingOptions": {
      "destinationUrl": "gs://sinch-storage/voice-recordings/my-recording.mp3",
      "credentials": "ACCESS_KEY:SECRET",
      "notificationEvents": true
      }
    }
}

Svaml instruction example

Copy

Copied

{
    "instructions": [{
        "name": "startRecording",
        "options": {
            "destinationUrl": "gs://sinch-storage/voice-recordings/my-recording.mp3",
            "credentials": "ACCESS_KEY:SECRET",
            "notificationEvents": true
            }
        }],
    "action": {
        "name": "connectPstn"
        ...
        }
}

Note: It's recommended that the credentials you specify authorize the Sinch platform to only write to the destination bucket. Sinch will never request read permissions.

TranscriptionOptions

If this option is enabled, a transcription of the audio call recording will be generated. The transcription is a JSON file with the Speech to Text representation of the recorded call.

The generated file will be saved on the same location as defined on the call recording destinationURL parameter.

Example

Copy

Copied

{
        "recordingOptions": {
            "destinationUrl": "sdrive://my-recording.mp3",
            "credentials": "ACCESS_KEY:SECRET",
            "notificationEvents": true,
            "transcriptionOptions": {
                    "enabled": true,
                    "locale": "en-US",
              },
        }
 }

Note:

sdrive = s3/azure/gs

Transcribed output file example

Copy

Copied

{
  "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
  "lines": [
    {
      "timestamp": 4.97,
      "speakerLabel": "Speaker 1",
      "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat."
    },
    {
      "timestamp": 5.6,
      "speakerLabel": "Speaker 2",
      "text": "Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."
    }
  ]
}

Notification events

Two notification events are sent to the partner’s backend if notificationEvents are enabled:

recording_finished - indicating that the recording for the specified call has been stopped either by a Manage Call request or because the call has ended
recording_available - indicating that the recording file is available in the specified destinationUrl and can be picked up
transcription_available - indicating that the transcription file is available in the specified destinationUrl and can be picked up

info

The notification event for a conference recording will contain conferenceId instead of callid

Example call recording

Copy

Copied

    {
        "event": "notify",
        "callid": "01234567-89ab-cdef-fedc-ba9876543210",
        "version": 1,
        "type": "recording_finished"
    }

    {
        "event": "notify",
        "callid": "01234567-89ab-cdef-fedc-ba9876543210",
        "version": 1,
        "type": "recording_available",
        "destination":"https://www.sinch.com/calling/v1/recording/201801010000_01234567-89ab-cdef-fedc-ba9876543210_01234567-89ab-cdef-fedc-ba9876543210.mp3"
    }

    {
        "event": "notify",
        "callid": "01234567-89ab-cdef-fedc-ba9876543210",
        "version": 1,
        "type": "transcription_available",
        "destination":"https://www.sinch.com/calling/v1/recording/201801010000_01234567-89ab-cdef-fedc-ba9876543210_01234567-89ab-cdef-fedc-ba9876543210-transcript.json"
    }

Example conference recording

Copy

Copied

    {
      "event": "notify",
      "conferenceId": "myConferenceId",
      "version": 1,
      "type": "recording_finished"
    }

    {
      "event": "notify",
      "conferenceId": "myConferenceId",
      "version": 1,
      "type": "recording_available",
      "destination": "s3://recordings/01234567-89ab-cdef-fedc-ba9876543210_01234567-89ab-cdef-fedc-ba9876543210.mp3"
    }