List voicemail records
Fetch a list of call detail records with VOICEMAIL preset status.
Query Parameters
Filter calls by internal number(s)
Filter calls by external number
Filter voicemails by new status, (IMPORTANT: when you filter by new status, all other filters are ignored)
Possible values: [TODAY
, THIS-WEEK
, LAST-TWO-WEEKS
, LAST-MONTH
]
Filter voicemails by date preset
Filter voicemails by whether they have notes
Filter voicemails by origin is anonymous
Filter voicemails by start date
Filter voicemails by end date
Include contact details in the response
Possible values: [ASC
, DESC
]
Default value: DESC
The order to sort the items in
The start date to filter on. It will be ignored if presetDate is set.
The end date to filter on. It will be ignored if presetDate is set.
Default value: 1
The page number to retrieve
Default value: 10
The number of items per page
- 200
- 400
- 401
- 500
Successfully retrieved the voicemail records
Schema
- Array [
- Array [
- ]
- ]
data object[]
The unique id of the call
The date and time of the call
Possible values: [inbound
, outbound
]
The direction of the call
externalNumber object
The external number of the call
Whether the external number is anonymous.
External number in localized format (or null).
External number in E.164 format (or null).
Whether the external number is on the client blacklist.
Whether the external number is on the global blacklist.
internalNumber object
The ID of the number, or null if is not active
The label of the number, or null if is not active or has no label
The phone number in E.164 format
The phone number in localized format
The duration of the call in seconds
Possible values: [MISSED
, ANSWERED
, VOICEMAIL
, ANSWERING_SERVICE
]
The status of the call
Possible values: [NO_ANSWER
, BLOCKED
, OUTSIDE_BUSINESS_HOURS
, null
]
The reason why the call was missed
user object
Possible values: [null
]
The unique id of the user
The initials of the user
The first name of the user
The last name of the user
The full name of the user
phoneNumber object
The phone number of the user in E.164 format
The country code of the user phone number in ISO 3166-1 alpha-2 format
The country calling code of the user phone number
The phone number of the user without country calling code
Possible values: [user
, admin
]
The role of the user
Possible values: [AVAILABLE
, UNAVAILABLE
]
The availability of the user
avatarUrls object
URL for the small sized avatar of the user (250x250)
URL for the large sized avatar of the user (500x500)
contact object
Possible values: [null
]
The ID of the contact
The first name of the user
The last name of the user
The initials of the user
The full name of the user
The company name of the user
numbers object[]
The label of the phone number
The phone number of the contact in E.164 format
The country code of the contact phone number in ISO 3166-1 alpha-2 format
The country calling code of the contact phone number
The phone number of the contact without country calling code
Whether or not the contact is a favorite
Whether or not the contact is shared with all the users in the account
The ID of the user that shared the contact
The ID of the number to use for outbound calls
The tag of the contact
The email address of the contact
avatarUrls object
Represents the URL for the small sized avatar of the contact (250x250)
Represents the URL for the large sized avatar of the contact (500x500)
voicemail object
Possible values: [null
]
The unique id of the voicemail
Whether the voicemail is new
The duration of the voicemail in seconds
The date until which the voicemail is available
The url to the audio stream of the voicemail
callRecording object
Possible values: [null
]
The unique id of the call recording
The date and time until the recording is available
The url to the audio stream of the call recording
Whether the call has notes
insights object
Possible values: [AVAILABLE
, IN_PROGRESS
, UNAVAILABLE
, FAILED
]
Possible values: [POSITIVE
, NEGATIVE
, NEUTRAL
, null
]
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": "64a6ac4a505f1d324f6cc220",
"date": "2020-01-01T12:00:00.000Z",
"direction": "inbound",
"externalNumber": {
"anonymous": false,
"localized": "085 060 9000",
"e164": "+31850609000",
"isOnClientBlacklist": false,
"isOnGlobalBlacklist": true
},
"internalNumber": {
"id": "64b8e900cbe7501ee8467d3e",
"label": "Rinkel",
"number": "+31850609000",
"localizedNumber": "085 060 9000"
},
"duration": 60,
"status": "ANSWERED",
"missedReason": null,
"user": {
"id": "64a6b60be7ce3a7774155263",
"initials": "JD",
"firstName": "John",
"lastName": "Doe",
"fullName": "John Doe",
"phoneNumber": {
"e164": "+31612345678",
"countryIsoCode": "NL",
"countryCallingCode": 31,
"number": "612345678"
},
"role": "user",
"availability": "AVAILABLE",
"avatarUrls": {
"small": "https://api.rinkel.com/users/64a6b60be7ce3a7774155263/avatar/small?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
"large": "https://api.rinkel.com/users/64a6b60be7ce3a7774155263/avatar/large?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
}
},
"contact": {
"id": "64a6ba73940fd11546c92f6e",
"firstName": "John",
"lastName": "Doe",
"initials": "JD",
"fullName": "John Doe",
"companyName": "Rinkel",
"numbers": [
{
"label": "Mobile",
"e164": "+31612345678",
"countryIsoCode": "NL",
"countryCallingCode": 31,
"number": "612345678"
}
],
"favorite": true,
"shared": true,
"sharedByUser": "64a6b60be7ce3a7774155263",
"defaultOutboundNumberId": "64b8e900cbe7501ee8467d3e",
"tag": "system",
"email": "[email protected]",
"avatarUrls": {
"small": "https://api.rinkel.com/contact/64a6ba73940fd11546c92f6e/avatar/small?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
"large": "https://api.rinkel.com/contact/64a6ba73940fd11546c92f6e/avatar/large?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
}
},
"voicemail": {
"id": "64a7e70f76d3cccf86d47d42",
"new": true,
"duration": 30,
"availableUntil": "2024-04-01T00:00:00.000Z",
"playUrl": "https://api.rinkel.com/voicemails/64a7e70f76d3cccf86d47d42/stream"
},
"callRecording": {
"id": "64a7e60337ee34ea78e5325c",
"availableUntil": "2020-01-01T12:00:00.000Z",
"playUrl": "https://api.rinkel.com/call-recordings/64a7e60337ee34ea78e5325c/stream"
},
"hasNotes": true,
"insights": {
"status": "AVAILABLE",
"sentiment": "POSITIVE",
"topics": [
"sales",
"support"
]
}
}
],
"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"
}
}
Invalid request body
Schema
- Array [
- ]
errors object[]
Human readable error code
Human readable error message
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
Internal Server Error