Doc Summary
Extracting Call Detail Records (CDR), Call Recordings & AI Transcriptions #
This document provides the API specifications required to integrate with the Dataphone Reporting API for retrieving Call Detail Records (CDR), call recordings, and AI-generated call transcriptions.
Important: These APIs are available only for customers with the appropriate services enabled.
Before beginning your integration, ensure you have obtained an API Key from Dataphone Technical Support. The API key is required to authenticate every request.
Authentication #
All API requests require authentication using a Bearer Token.
Request Header #
Authorization: Bearer YOUR_API_KEY
Replace YOUR_API_KEY with the API key provided by Dataphone Technical Support.
1. Retrieve Call Detail Records (CDR) #
Use this endpoint to retrieve Call Detail Records for a specific date.
API Endpoint #
https://reporting-api.dataphone.cloud/cdr
HTTP Method #
POST
Request Headers #
| Header | Value |
|---|---|
| Content-Type | application/json |
| Authorization | Bearer YOUR_API_KEY |
Request Body #
The request body must be sent in JSON format.
{
"datetime": "2026-06-28"
}
Date Format #
The datetime parameter must use the following format:
YYYY-MM-DD
Example:
2026-06-28
Successful Response #
A successful request returns a JSON array containing the Call Detail Records for the specified date.
Each CDR record includes a unique ID, which is required to retrieve the associated call recording or AI transcription.
Example (truncated):
[
{
"id": "123456789",
"caller_id": "2125551000",
"destination": "1001",
"start_time": "2026-06-28T14:35:12Z",
"duration": 185
}
]
2. Retrieve Call Recording #
After obtaining the CDR results, locate the ID for the desired call record.
Use that ID to retrieve the corresponding call recording.
API Endpoint #
https://recordings.dataphone.cloud/recordings/ID
Replace:
ID
with the CDR record ID returned from the CDR API.
Example:
https://recordings.dataphone.cloud/recordings/123456789
HTTP Method #
GET
Request Headers #
| Header | Value |
|---|---|
| Content-Type | application/json |
| Authorization | Bearer YOUR_API_KEY |
Successful Response #
If a recording exists, the API returns the recording associated with the specified CDR ID.
3. Retrieve AI Call Transcription #
If AI Transcription is enabled for your account, you can retrieve the AI-generated transcription using the same CDR ID.
API Endpoint #
https://recordings.dataphone.cloud/transcription/ID
Replace:
ID
with the CDR record ID returned from the CDR API.
Example:
https://recordings.dataphone.cloud/transcription/123456789
HTTP Method #
GET
Request Headers #
| Header | Value |
|---|---|
| Content-Type | application/json |
| Authorization | Bearer YOUR_API_KEY |
Successful Response #
If AI transcription is available for the specified recording, the API returns the transcription in JSON format.
Error Handling #
The API may return the following HTTP status codes:
| Status Code | Description |
|---|---|
| 200 OK | Request completed successfully. |
| 400 Bad Request | Invalid request body or missing required parameters. |
| 401 Unauthorized | Invalid or missing API key. |
| 403 Forbidden | Your account does not have permission to access the requested resource. |
| 404 Not Found | The requested CDR, recording, or transcription could not be found. |
| 500 Internal Server Error | An unexpected server error occurred. Please try again later. |
Troubleshooting #
Authentication Failed (401) #
- Verify that the API key is included in the
Authorizationheader. - Ensure the key is formatted as:
Bearer YOUR_API_KEY
- Confirm the API key is active and has not expired.
No CDR Records Returned #
- Verify that the requested date contains call records.
- Ensure the
datetimevalue is in the required format:
YYYY-MM-DD
Recording Not Found #
- Confirm the recording exists for the selected CDR.
- Verify that the correct CDR ID is being used.
- Some calls may not have recordings if call recording was disabled.
AI Transcription Not Found #
- Verify that AI Transcription is enabled for your account.
- Ensure the selected call has been successfully processed.
- Confirm that the correct CDR ID is being used.
Internal Server Error (500) #
If the issue persists after retrying the request, please contact Dataphone Technical Support and provide:
- The API endpoint being called
- Date and time of the request
- HTTP status code received
- The request payload (if applicable)
- The CDR ID (if applicable)
This information will help expedite troubleshooting.
