Get a specific call detail record

Retrieve the details of a specific call detail record by its ID.

Path Parameters

id string required

The unique identifier of the call detail record

Responses

• 200
• 400
• 401
• 403
• 404
• 500

---

Successfully retrieved the call detail record

application/json

Schema

Example (from schema)

---

Schema

data object
id string
The unique id of the call
callId string
The original id of the call on the network (used in webhook events)
date date-time
The date and time of the call
direction string
Possible values: [inbound, outbound]
The direction of the call
externalNumber object
The external number of the call
anonymous boolean
Whether the external number is anonymous.
localized string nullable
External number in localized format (or null).
e164 string nullable
External number in E.164 format (or null).
isOnClientBlacklist boolean
Whether the external number is on the client blacklist.
isOnGlobalBlacklist boolean
Whether the external number is on the global blacklist.
internalNumber object
id string nullable
The ID of the number, or null if is not active
label string nullable
The label of the number, or null if is not active or has no label
number string
The phone number in E.164 format
localizedNumber string
The phone number in localized format
duration integer
The duration of the call in seconds
status string
Possible values: [MISSED, ANSWERED, VOICEMAIL, ANSWERING_SERVICE]
The status of the call
missedReason string nullable
Possible values: [NO_ANSWER, BLOCKED, OUTSIDE_BUSINESS_HOURS, null]
The reason why the call was missed
menuOption string nullable
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 0, *, #, null]
The IVR option that was selected
user object
Possible values: [null]
id string
The unique id of the user
initials string
The initials of the user
firstName string
The first name of the user
lastName string
The last name of the user
fullName string
The full name of the user
phoneNumber object
e164 string
The phone number of the user in E.164 format
countryIsoCode string
The country code of the user phone number in ISO 3166-1 alpha-2 format
countryCallingCode number
The country calling code of the user phone number
number string
The phone number of the user without country calling code
role string
Possible values: [user, admin, answeringService]
The role of the user
availability string
Possible values: [AVAILABLE, UNAVAILABLE]
The availability of the user
avatarUrls object
small uri nullable
URL for the small sized avatar of the user (250x250)
large uri nullable
URL for the large sized avatar of the user (500x500)
contact object
Possible values: [null]
id string
The ID of the contact
firstName string
The first name of the user
lastName string
The last name of the user
initials string
The initials of the user
fullName string
The full name of the user
companyName string nullable
The company name of the user
numbers object[]
Array [
label string
The label of the phone number
e164 string
The phone number of the contact in E.164 format
countryIsoCode string
The country code of the contact phone number in ISO 3166-1 alpha-2 format
countryCallingCode number
The country calling code of the contact phone number
number string
The phone number of the contact without country calling code
localized string
The phone number of the contact in localized format
]
favorite boolean
Whether or not the contact is a favorite
shared boolean
Whether or not the contact is shared with all the users in the account
sharedByUser string nullable
The ID of the user that shared the contact
defaultOutboundNumberId string nullable
The ID of the number to use for outbound calls
tag string nullable
The tag of the contact
email string nullable
The email address of the contact
avatarUrls object
small uri nullable
Represents the URL for the small sized avatar of the contact (250x250)
large uri nullable
Represents the URL for the large sized avatar of the contact (500x500)
voicemail object
Possible values: [null]
id string
The unique id of the voicemail
new boolean
Whether the voicemail is new
duration integer
The duration of the voicemail in seconds
availableUntil date-time
The date until which the voicemail is available
playUrl uri
The url to the audio stream of the voicemail
callRecording object
Possible values: [null]
id string
The unique id of the call recording
availableUntil date-time
The date and time until the recording is available
playUrl uri
The url to the audio stream of the call recording
notes object[]
Array [
id string
The unique id of the note
date date-time
The date and time the note was added
user string
The ID of the user that added the note
content string
The content of the note
]
insights object
status string
Possible values: [AVAILABLE, IN_PROGRESS, UNAVAILABLE, FAILED]
summary string nullable
customSummary string nullable
sentiment string nullable
Possible values: [POSITIVE, NEGATIVE, NEUTRAL, null]
topics array nullable

{
  "data": {
    "id": "64a6ac4a505f1d324f6cc220",
    "callId": "eff7c60d5790f0b5d54f7d9ee15d0a9f",
    "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",
          "localized": "06 12345678"
        }
      ],
      "favorite": true,
      "shared": true,
      "sharedByUser": "64a6b60be7ce3a7774155263",
      "defaultOutboundNumberId": "64b8e900cbe7501ee8467d3e",
      "tag": "system",
      "email": "johndoe@rinkel.com",
      "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

GET /call-detail-records/:id

Authorization

name: x-rinkel-api-keytype: apiKeyin: header

Request

Base URL

https://api.rinkel.com/v1

apiKeyAuth

id — path required

curl / cURL

curl -L -X GET 'https://api.rinkel.com/v1/call-detail-records/:id' \
-H 'Accept: application/json' \
-H 'x-rinkel-api-key: <API_KEY_VALUE>'

nodejs / axios

curl -L -X GET 'https://api.rinkel.com/v1/call-detail-records/:id' \
-H 'Accept: application/json' \
-H 'x-rinkel-api-key: <API_KEY_VALUE>'

php / axios

curl -L -X GET 'https://api.rinkel.com/v1/call-detail-records/:id' \
-H 'Accept: application/json' \
-H 'x-rinkel-api-key: <API_KEY_VALUE>'

python / requests

curl -L -X GET 'https://api.rinkel.com/v1/call-detail-records/:id' \
-H 'Accept: application/json' \
-H 'x-rinkel-api-key: <API_KEY_VALUE>'

ruby / cURL

curl -L -X GET 'https://api.rinkel.com/v1/call-detail-records/:id' \
-H 'Accept: application/json' \
-H 'x-rinkel-api-key: <API_KEY_VALUE>'

java / unirest

curl -L -X GET 'https://api.rinkel.com/v1/call-detail-records/:id' \
-H 'Accept: application/json' \
-H 'x-rinkel-api-key: <API_KEY_VALUE>'