Conference Recordings

Get a Conference Recording

Changed on

Retrieves one voice-conference recording's metadata by conference SID and recording SID. Use List Conference Recordings to discover recording SIDs; Video Room recordings are separate media resources.

Request the recording URI with a .json extension to get the metadata. With .mp3, the URI responds with a 302 redirect to an MP3 version of the recording. Without an extension, the response follows the request's Accept header: application/json returns the metadata, and a generic value such as */* redirects to a WAV version. When the recording has no audio to return, for example because its status isn't completed, the audio URIs respond with 404 and an empty body.

Access follows the project's Protect Recording Media URLs setting, which new projects have turned on. When it's on, authenticate with your Project ID and an API token that has the Management scope; otherwise the request gets a 401. When it's off, anyone with the URI can retrieve the recording without authenticating. See Retrieve a Recording for details.

get/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Recordings/{Sid}.json

Request

  • Base URL
    https://YOUR_SPACE.signalwire.com/api/laml/2010-04-01
  • URL
    https://YOUR_SPACE.signalwire.com/api/laml/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Recordings/{Sid}.json
  • Auth
    HTTP basic

Path parameters

AccountSidstring uuid required

Universal Unique Identifier.

The unique identifier for the account that created this conference.

ConferenceSidstring uuid required

Universal Unique Identifier.

The unique identifier for the conference this participant is in.

Sidstring uuid required

Universal Unique Identifier.

The unique identifier for the recording.

Response

The request has succeeded.

sidstring uuid required

Universal Unique Identifier.

account_sidstring uuid required

Universal Unique Identifier.

api_versionstring required

The version of the SignalWire API.

call_sidstring nullable required

The unique identifier for the call. Always null for conference recordings.

conference_sidstring uuid required

Universal Unique Identifier.

channel'1' | '2' required

The number of channels in a recording (singular key). Returns '1' for mono or '2' for stereo.

channels'1' | '2' required

The number of channels in a recording. Returns '1' for mono or '2' for stereo.

date_createdstring required

The date, in RFC 2822 format, this recording was created.

date_updatedstring required

The date, in RFC 2822 format, this recording was updated.

start_timestring nullable required

The time, in RFC 2822 format, this recording started.

end_timestring nullable required

The time, in RFC 2822 format, this recording ended.

durationinteger required

The length, in seconds, of the recording.

pricenumber double required

The cost of the recording.

price_unitstring required

The currency of the price of the recording.

source'Conference' required

Recording source for conference recordings. Always Conference.

status'queued' | 'in-progress' | 'paused' | 'resumed' | 'completed' | 'absent' | 'stopped' required

Recording status.

error_codestring nullable required

Further details about a failed recording.

uristring required

The URI of the recording.

encryption_detailsstring nullable required

Encryption details. Always null.

trimstring nullable required

Whether leading and trailing silence is trimmed from a recording: trim-silence or do-not-trim. Can be null, for example on conference recordings.

Example response

{
  "api_version": "2010-04-01",
  "channel": "1",
  "channels": "1",
  "date_created": "Tue, 25 Sep 2018 23:00:00 +0000",
  "date_updated": "Wed, 26 Sep 2018 23:00:04 +0000",
  "start_time": "Tue, 25 Sep 2018 23:00:00 +0000",
  "end_time": "Wed, 26 Sep 2018 23:00:04 +0000",
  "duration": 4,
  "price": 0.0025,
  "price_unit": "USD",
  "uri": "/api/laml/2010-04-01/Accounts/720796a0-8ee9-4350-83bd-2d07a3121f1e/Conferences/43bb71ee-553f-4074-bb20-8e2747647cce/Recordings/19e436af-5688-4307-b03b-bdb2b42b8142.json",
  "subresource_uris": {
    "transcriptions": "/api/laml/2010-04-01/Accounts/720796a0-8ee9-4350-83bd-2d07a3121f1e/Recordings/19e436af-5688-4307-b03b-bdb2b42b8142/Transcriptions.json"
  }
}

Changes

    • breaking

      removed the media type application/json for the response with the status

    • info

      added the media type text/plain for the response with the status

    • info

      removed the StartConferenceRecording enum value from the //// response property for the response status