Get a recording

Get a recording by its ID

Path Parameters

id string required

The ID of the recording to retrieve

Responses

• 200
• 400
• 401
• 404
• 500

---

Successfully retrieved the recording

application/json

Schema

Example (from schema)

---

Schema

data object
id string
The unique id of the recording
name string
The name of the recording
description string nullable
The description of the recording
script string nullable
The script the User entered when the recording was created
playUrl uri
The url to the audio stream of the recording
date date-time
The date and time the recording was created
duration number
The duration of the recording in seconds
usage object nullable
Where the recording is used
property name* object[] nullable
Array [
feature string
Possible values: [businessHours, callRecording, forwarding, greeting, voiceMenu]
meta object
dtmf string
]

{
  "data": {
    "id": "654367fa9ee46392f4b84247",
    "name": "My recording",
    "description": "This is a description of the recording",
    "script": "Thank you for calling My Company. We’re unavailable at the moment, but leave your name & number, and we’ll get back to you as soon as possible",
    "playUrl": "https://api.rinkel.com/recordings/64a7e70f76d3cccf86d47d42/stream",
    "date": "2020-01-01T12:00:00.000Z",
    "duration": 60,
    "usage": {}
  }
}

Bad request

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
code string
Human readable error code
message string
Human readable error message
detail string
Human readable error detail
]

{
  "errors": [
    {
      "code": "ERROR_CODE",
      "message": "An error occurred while calling the endpoint",
      "detail": "View more info at developers.rinkel.com"
    }
  ]
}

Unauthorized

The recording was not found

Internal Server Error

Loading...