Get a specific call detail record
Retrieve the details of a specific call detail record by its ID.
Path Parameters
The unique identifier of the call detail record
- 200
- 400
- 401
- 403
- 404
- 500
Successfully retrieved the call detail record
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
Possible values: [1
, 2
, 3
, 4
, 5
, 6
, 7
, 8
, 9
, 0
, *
, #
, null
]
The IVR option that was selected
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
notes object[]
The unique id of the note
The date and time the note was added
The ID of the user that added the note
The content of the note
insights object
Possible values: [AVAILABLE
, IN_PROGRESS
, UNAVAILABLE
, FAILED
]
Possible values: [POSITIVE
, NEGATIVE
, NEUTRAL
, null
]
{
"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,
"menuOption": 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"
},
"notes": [
{
"id": "64a6ac4a505f1d324f6cc220",
"date": "2024-01-01T12:00:00.000Z",
"user": "64a6ba73940fd11546c92f6e",
"content": "This is a note"
}
],
"insights": {
"status": "AVAILABLE",
"summary": "This is a summary of the call generated by AI insights",
"customSummary": "This is a custom summary of the call",
"sentiment": "POSITIVE",
"topics": [
"sales",
"support"
]
}
}
}
Invalid ID supplied
Unauthorized
Forbidden
Call detail record not found
Internal Server Error