NEWDolby Interactivity APIs are now the Dolby.io Communications APIs Learn More >
X

Recording.Audio.Available

The Recording.Audio.Available webhook event is sent when the recorded conference in MP3 format is ready and can be downloaded through the URL link included in the webhook event. This event is available only for Dolby Voice conferences. The URL has a limited validity and expires after five minutes.

The splits webhook element allows receiving separate audio recordings for each conference participant. To use the split recording, enable the Generate audio recordings for each participant option in the dashboard.

To receive both recording formats in the case of Dolby Voice conferences, select the BOTH recording format and use Recording.MP4.Available and Recording.Audio.Available webhook events. The Recording.Audio.Available webhook can include links only to the MP3 recordings.

Split recording disabled:

{
  "conference": {
    "confId": "conferenceId_UUID",
    "confAlias": "example_conference_alias"
  },
  "thirdPartyId": "example_thirdpartyId",
  "region": "eu",
  "eventType": "Recording.Audio.Available",
  "filename": "example_file_name",
  "duration": 6400,
  "size": 78624,
  "url": "url_to_recording",
  "records": [
    {
      "startTime" : 1602086897206,
      "duration": 67540,
      "size": 10000,
      "filename": "record_{timestamp_epoch}_conf_{conference_id}.mp3",
      "url": "url_to_recording"
    },
    {
      "startTime" : 1602086897300,
      "duration": 1223,
      "size": 10000,
      "filename": "record_{timestamp_epoch}_conf_{conference_id}.mp3",
      "url": "url_to_recording"
    }
  ]
}

Split recording enabled:

{
    "conference": {
        "confId": "conferenceId_UUID",
        "confAlias": "example_conference_alias"
    },
    "thirdPartyId": "example_thirdpartyId",
    "region": "eu",
    "eventType": "Recording.Audio.Available",
    "filename": "example_file_name",
    "duration": 6400,
    "size": 78624,
    "url": "url_to_recording",
    "records": [
        {
            "startTime": 1602086897206,
            "duration": 6400,
            "size": 78624,
            "filename": "record_{timestamp_epoch}_conn_{user_id}_{user_record_start_time}.mp3",
            "url": "url_to_recording",
            "splits": [
                {
                    "startTime": 1602086897300,
                    "duration": 6420,
                    "size": 41256,
                    "filename": "record_{timestamp_epoch}_conn_{user_id}_{user_record_start_time}.mp3",
                    "userId": "userId_UUID",
                    "url": "url_to_recording",
                    "metadata": {
                        "preferSendMono": "false",
                        "externalName": "external_name",
                        "externalPhotoUrl": "link_to_participant_photo",
                        "simulcast": "false",
                        "preferRecvMono": "false"
                    }
                }
            ]
        }
    ]
}

Where:

  • startTime is the time when the conference started, in milliseconds since epoch.
  • region is the conference region, the possible values are:
    • ca: Canada
    • us: US
    • eu: EU
    • in: India
    • au: Australia
  • duration is the recording duration in milliseconds.
  • size is the recording file size in bytes.

Did this page help you?