Recording.Audio.Available

The Recording.Audio.Available event is sent when the recorded conference in MP3 format is ready and can be downloaded through the URL link included in the webhook. This event is available only for conferences enabled with Dolby Voice.

The type of recording depends on the settings in the developer portal. For more information, refer to this page.

The splits element contains separate audio recordings for each conference participant, identified by the participant ID. This feature is disabled by default. You can enable split recording using the developer portal.

Note: When using the Recording.Audio.Available webhook with the BOTH option, the webhook includes only the MP3 recording.

The following table lists the supported recording options for the Recording.Audio.Available webhook:

MP3 MP4 BOTH
Split disabled Split enabled Split disabled Split enabled Split disabled Split enabled
Non-Dolby Voice conferences - - - - - -
Dolby Voice conferences - -

Split recording disabled:

{
  "conference": {
    "confId": "conferenceId_UUID",
    "confAlias": "example_conference_alias"
  },
  "thirdPartyId": "example_thirdpartyId",
  "region": "eu",
  "eventType": "Recording.Audio.Available",
  "records": [
    {
      "start_time" : EPOCH_timestamp,
      "duration": 67540,
      "size": 10000,
      "filename": "record_{timestamp_epoch}_conf_{conference_id}.mp3",
      "url": "url_to_recording"
    },
    {
      "start_time" : EPOCH_timestamp,
      "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",
    "records": [
        {
            "startTime": EPOCH_timestamp,
            "duration": 6400,
            "size": 78624,
            "filename": "record_{timestamp_epoch}_conn_{user_id}_{user_record_start_time}.mp3",
            "url": "url_to_recording",
            "splits": [
                {
                    "startTime": EPOCH_timestamp,
                    "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
    • sg: Singapore
  • duration is the recording duration in milliseconds.
  • size is the recording file size in bytes.