Download AI Call Transcription Data

Download a JSON file of desired AI call transcription data from CDR, including the call transcript and summary.

Note: This interface is only available in API version 2.0.

Steps to download AI call transcription data

  1. Get the download URL.
  2. Download the JSON file.

Request URL

GET {base_url}/{api_path}/cdr/aidownload?access_token={access_token}

Request parameters

Tip: Use the request parameters to filter the transcription data as needed.
Parameter Required Type Description
call_from No String Number of the caller who initiated the call.
call_to No String Number of the caller who received the call.
call_type No String The communication type of the call.
Valid value:
  • Internal
  • Inbound
  • Outbound
start_time No String Start time of the query period.
Note: The time format depends on the date and time display format of PBX (set in System > Date and Time > Display Format on PBX).

Examples:

  • If the display format is Month/Day/Year and is 24-hours format, then the valid time format is MM/DD/YYYY HH:mm:ss.
  • If the display format is Year/Month/Day and is 12-hours format, then the valid time format is YYYY/MM/DD HH:mm:ss AM or YYYY/MM/DD HH:mm:ss PM.
end_time No String End time of the query period.
Note: The time format depends on the date and time display format of PBX (set in System > Date and Time > Display Format on PBX).

Examples:

  • If the display format is Month/Day/Year and is 24-hours format, then the valid time format is MM/DD/YYYY HH:mm:ss.
  • If the display format is Year/Month/Day and is 12-hours format, then the valid time format is YYYY/MM/DD HH:mm:ss AM or YYYY/MM/DD HH:mm:ss PM.
last_status No String The final status of the call.
Valid value:
  • ANSWERED
  • NO ANSWER
  • ABANDONED
  • BUSY
  • FAILED
  • VOICEMAIL

Response parameters

Parameter Type Description
errcode Integer Returned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsg String Returned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.
file String The name of the AI call transcription data JSON file.
download_resource_url String The download URL of the AI call transcription data JSON file.
Note: The download URL is valid only for 30 minutes.

Example

Request example

Get the download URL of the AI call transcription data.

GET /openapi/v2.0/cdr/aidownload?access_token=vtqkVFQcIfbDuWGjSScZk6RGzO0Zdfic HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

Response example

{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "file": "PBX-AI_Transcription-X.23.0.70-download-20260514104731-PXFbRkarEjkQzHFL.json",
    "download_resource_url": "/api/download/PBX-AI_Transcription-X.23.0.70-download-20260514104731-PXFbRkarEjkQzHFL.json"
}

Download the AI call transcription data

After obtaining the download URL for the JSON file, combine it with the {base_url} and append the {access_token} parameter. Then, use the complete link to download the desired file.

Download link format

{base_url}/{download_resource_url}?access_token={access_token}

Download link example

https://yeastardocs.example.yeastarcloud.com/api/download/PBX-AI_Transcription-X.23.0.70-download-20260514104731-PXFbRkarEjkQzHFL.json?access_token=vtqkVFQcIfbDuWGjSScZk6RGzO0Zdfic

Downloaded File Content

The content of the downloaded file is detailed below.

JSON example
 [
    {
        "uid": "20260509214921EFE9A",
        "leg_id": "20260509214921-8AA6D",
        "leg": 1,
        "time": "2026/05/09 21:49:21",
        "call_type": "Internal",
        "call_from": "3200",
        "call_to": "7000",
        "status": "ANSWERED",
        "call_duration": 13,
        "ring_duration": 3,
        "talk_duration": 10,
        "hold_duration": 0,
        "ai_transcription": [
            {
                "source_number": "7000",
                "content": "Hi",
                "timestamp": 1778334561705,
                "duration": 0
            }
        ],
        "ai_summary": "The conversation began with the agent initiating contact with a simple greeting."
    },
    ....
]

Parameter description

Parameter Type Description
uid String The unique ID of CDR to which the call leg belongs.
leg_id String The ID of the call leg.
leg Integer The sequence number of the call leg in the downloaded data.
time String The time when the call was initiated or received.
call_type String The communication type of the call.
  • Internal
  • Inbound
  • Outbound
call_from String The number of the caller who initiated the call.
call_to String The number of the callee who received the call.
status String The final status of the call leg.
  • ANSWERED
  • NO ANSWER
  • BUSY
  • FAILED
  • VOICEMAIL
  • ABANDONED
call_duration Integer The time between the call stared and the call ended (in secondes).
ring_duration Integer The time between the call started and the call answered (in secondes).
talk_duration Integer The time between the call answered and the call ended (in secondes).
Note: The call hold time is excluded.
hold_duration Integer The time during which the call is placed on hold (in secondes).
ai_transcription Array<Context> AI-generated call transcript content.
ai_summary String AI-generated call summary content.
Context
Parameter Type Description
source_number string The number of the user who spoke the original content of this record.
content String The transcribed text content.
timestamp integer The timestamp (in milliseconds) of the original event that generated this transcription record (i.e., when a sentence was spoken).
duration integer The length of the original speech that this transcription record corresponds to (in seconds).