List all recordings
List all recordings
Query Parameters
Default value: 1
The page number to retrieve
Possible values: >= 1
and <= 50
Default value: 10
The number of items per page, max 50
Possible values: [date
, duration
, name
, description
]
Default value: date
Sort recordings by a field
Possible values: [ASC
, DESC
]
Default value: DESC
The order to sort the items in
- 200
- 401
- 500
Successfully retrieved the recording(s)
Schema
- Array [
- Array [
- ]
- ]
data object[]
The unique id of the recording
The name of the recording
The description of the recording
The script the User entered when the recording was created
The url to the audio stream of the recording
The date and time the recording was created
The duration of the recording in seconds
usage object nullable
Where the recording is used
property name* object[] nullable
Possible values: [businessHours
, callRecording
, forwarding
, greeting
, voiceMenu
]
meta object
meta object
pagination object
The number of items in the collection
The number of pages in the collection
The current page
Possible values: >= 1
and <= 50
The number of items per page
links object
The url to the first page
The url to the first page
The url to the last page
The url to the previous page
The url to the next page
{
"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": {}
}
],
"meta": {
"pagination": {
"totalItems": 100,
"totalPages": 10,
"currentPage": 1,
"perPage": 10
},
"links": {
"self": "https://api.rinkel.com/users?page=1",
"first": "https://api.rinkel.com/users?page=1",
"last": "https://api.rinkel.com/users?page=10",
"previous": null,
"next": "https://api.rinkel.com/users?page=2"
}
}
}
Unauthorized
Internal Server Error