Skip to main content

Fetch recording resource

GET 
/texml/Accounts/:account_sid/Recordings/:recording_sid.json

Returns recording resource identified by recording id.

Request​

Path Parameters

    account_sid stringrequired

    The id of the account the resource belongs to.

    recording_sid uuidrequired

    Uniquely identifies the recording by id.

Responses​

200: Retrieves call recording resource.

Schema

    account_sid AccountSid (string)
    call_sid CallControlId (string)
    conference_sid uuidnullable
    channels TwimlRecordingChannels (integer)

    Possible values: [1, 2]

    Default value: 2

    date_created datetime-rfc2822
    date_updated datetime-rfc2822
    start_time datetime-rfc2822
    duration TexmlRecordingDuration (string)nullable

    The duration of this recording, given in seconds.

    sid TexmlSid (string)

    Identifier of a resource.

    source RecordingSource (string)

    Possible values: [StartCallRecordingAPI, StartConferenceRecordingAPI, OutboundAPI, DialVerb, Conference, RecordVerb, Trunking]

    Defines how the recording was created.

    status TexmlRecordingStatus (string)

    Possible values: [in-progress, completed, paused, stopped]

    error_code TexmlErrorCode (string)nullable

    subresources_uris

    object

    Subresources details for a recording if available.

    transcriptions urinullable

    Subresources details for a recording if available.

    uri string

    The relative URI for this recording resource.

    media_url uri

404: Resource not found

Schema

    errors

    object[]

  • Array [

    • detail string

  • ]

Request samples

curl -L 'https://api.telnyx.com/v2' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

{
  "account_sid": "61bf923e-5e4d-4595-a110-56190ea18a1b",
  "call_sid": "v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA",
  "conference_sid": "cd5a70f4-759b-4d5e-9c06-88c00f16f3c1",
  "channels": 1,
  "date_created": "Fri, 11 Aug 2023 19:12:11 +0000",
  "date_updated": "Fri, 11 Aug 2023 19:12:11 +0000",
  "start_time": "Fri, 11 Aug 2023 19:12:11 +0000",
  "duration": "12",
  "sid": "e9cea0be-7dbd-4b98-98b1-c0089d9d43b0",
  "source": "StartCallRecordingAPI",
  "status": "paused",
  "error_code": null,
  "subresources_uris": {
    "transcriptions": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Recordings/b08f0fa1-a32c-4218-b3b5-9cf78941ccac/Transcriptions.json"
  },
  "uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Recordings/b08f0fa1-a32c-4218-b3b5-9cf78941ccac.json",
  "media_url": "http://recordings.com/mp3/filename.mp3"
}