Recordings

Get recording

Changed on

Retrieves one voice call recording by ID. Use it after listing recordings or when a call event saved the recording identifier. Use Compatibility Retrieve recording for SID-based recording routes, or Get room recording for video-room media.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice.

Learn more about API scopes.

get/api/relay/rest/recordings/{id}

Request

  • Base URL
    https://{Your_Space_Name}.signalwire.com
  • URL
    https://{Your_Space_Name}.signalwire.com/api/relay/rest/recordings/{id}
  • Auth
    HTTP basic

Path parameters

idstring uuid required

Universal Unique Identifier.

Unique ID of the recording.

Response

Recording model. A recording is associated with exactly one source type (PSTN, SIP, WebRTC, or Relay conference).

OR
OR
OR

Example response

{
  "duration_in_seconds": 2,
  "price": 0.05,
  "price_unit": "USD",
  "status": "finished",
  "url": "/api/relay/rest/recordings/d3444402-7b43-4512-8735-9d5e1f387814",
  "byte_size": 10,
  "track": "inbound"
}

Changes

  • 64cf005f3c13Revision changes
    • breaking

      response property anyOf[ConferenceRecording]/error_code list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property anyOf[PstnRecording]/error_code list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property anyOf[SipRecording]/error_code list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property anyOf[WebRtcRecording]/error_code list-of-types was widened by adding types null to media type application/json of response 200

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

  • 232721dea516Revision changes
    • breaking

      the response property //// became optional for the status

    • breaking

      the response property //// became optional for the status

    • breaking

      the response property //// became optional for the status

    • breaking

      the response property //// became optional for the status

    • info

      response property anyOf[ConferenceRecording]/error_code list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property anyOf[PstnRecording]/error_code list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property anyOf[SipRecording]/error_code list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property anyOf[WebRtcRecording]/error_code list-of-types was narrowed by removing types null from media type application/json of response 200

Some revisions have not been checked yet.