Missing Fields in Zoom History API for Call Reporting

API and Webhooks Reports and Dashboards
1

Missing Fields in Zoom History API for Call Reporting -
https://api.zoom.us/v2/phone/call_history_detail

I wanted to bring to your attention the specific data fields we rely on to generate our final call reports. Currently, we run SQL queries against the downloaded Zoom reports, and here are a few examples of the metrics we extract:

SPANISH CALLS

SELECT COUNT(Time) AS SPANISH

FROM ZOOM

WHERE Event = ‘IVR (8)’

AND [To] LIKE ‘%XXX%’

VOICEMAIL

SELECT SUM(CASE WHEN [Result] = ‘Voicemail’

THEN 1 ELSE 0 END) AS Voicemail

FROM ZOOM

IST (Forwarded Calls)

SELECT COUNT(Time) AS Forwarded_IST

FROM ZOOM

WHERE [To] LIKE ‘%XXX%’

However, when using the Zoom History API, I’m unable to retrieve these types of results because key fields such as Event, To, or Result are either missing or not in the expected format.

Could you please clarify:

  • Whether these fields are available via any Zoom API endpoint (e.g., call logs, telephony reports)?
  • If not, are there plans to include them in future API updates?
  • Is there a recommended approach to retrieving equivalent call event information programmatically?

Your guidance would be greatly appreciated.

2

Hi @Sajith
Thanks for reaching out to us.
There are 2 endpoints that you can use to call logs from the API
The first one is the Get account’s call history endpoint:

You can get more detailed and use the call log id returned in the previous endpoint and call the Get call path endpoint to get the logs of a specific call

Let me know if this helps!

3

Hi Elisa,

Thanks so much for your quick response — really appreciate your help!

I’ve tried working with the endpoints you mentioned and have been able to retrieve some call data successfully. However, to fully match the level of detail provided in the Zoom web portal’s downloaded call log reports, I still need access to more specific fields for building internal analytics reports.

I’ve attached a screenshot showing the fields we get when downloading the call log Excel report from the Zoom portal. These are the fields we’re aiming to retrieve via the API:

NO., Direction, Call ID, From Name, From Ext., From Phone Number, 
To Name, To Email, To Ext., To Phone Number, Operator Name, 
Operator Ext., Type, Start Time, Event, Call Result, 
Duration, Wait Time, Device, Site

Some important points:

  • The “Event” field in the downloaded report includes IVR statuses like IVR(2), IVR(3), IVR(4), etc., which we’re currently unable to replicate via the API.

  • Each call often spans multiple rows in the Excel report to reflect different stages of the call, which is critical for our reporting.

  • These details are especially important for identifying calls routed through specific IVRs or Auto Receptionists (used in Spanish call routing and IST call forwarding).

Is there any way to retrieve these multi-leg breakdowns and IVR interaction data through the API?

Thanks again for your guidance!

Thanks,
-Sajith

4

Hi @Sajith
did you look into the Get pall endpoint?
This endpoint provides you the sequence of the call or as you said the different stages of the call.
It includes direction, call id, caller and calee information, as well as the numbers, device type, etc

This is a sample response body from that endpoint:

{
  "id": "20211008-48c1dfd4-91ce-4df5-8495-7c9e33d10869",
  "call_id": "7018317023722949162",
  "connect_type": "internal",
  "call_type": "general",
  "direction": "inbound",
  "international": false,
  "hide_caller_id": true,
  "end_to_end": false,
  "caller_ext_id": "ATu63--9TjudZetpf4UuQg",
  "caller_name": "Caller name",
  "caller_did_number": "+12059300920",
  "caller_ext_number": "101229",
  "caller_email": "test@abc.com",
  "caller_ext_type": "user",
  "callee_ext_id": "ATu63--9TjudZetpf4UuQg",
  "callee_name": "Callee name",
  "callee_email": "test@abc.com",
  "callee_did_number": "+12059300920",
  "callee_ext_number": "101229",
  "callee_ext_type": "user",
  "department": "web-api1",
  "cost_center": "cost-center1",
  "site_id": "BpCTBMRARBefUrprildVqw",
  "group_id": "California",
  "site_name": "site name",
  "start_time": "2021-10-08T16:12:04Z",
  "answer_time": "2021-10-08T16:12:04Z",
  "end_time": "2021-10-08T16:12:15Z",
  "call_path": [
    {
      "id": "48c1dfd4-91ce-4df5-8495-7c9e33d10869",
      "call_id": "7018317023722949162",
      "connect_type": "internal",
      "call_type": "general",
      "direction": "inbound",
      "hide_caller_id": true,
      "end_to_end": false,
      "caller_ext_id": "ATu63--9TjudZetpf4UuQg",
      "caller_name": "Caller name",
      "caller_email": "test@abc.com",
      "caller_did_number": "+12059300920",
      "caller_ext_number": "101229",
      "caller_ext_type": "user",
      "caller_number_type": "external_pstn",
      "caller_device_type": "MAC_Client(6.0.2.33403)",
      "caller_country_iso_code": "US",
      "caller_country_code": "US",
      "callee_ext_id": "ATu63--9TjudZetpf4UuQg",
      "callee_name": "Callee name",
      "callee_did_number": "+12059300920",
      "callee_ext_number": "101229",
      "callee_email": "test@abc.com",
      "callee_ext_type": "user",
      "callee_number_type": "external_pstn",
      "callee_device_type": "MAC_Client(6.0.2.33403)",
      "callee_country_iso_code": "US",
      "callee_country_code": "US",
      "client_code": "1234",
      "department": "web-api1",
      "cost_center": "cost-center1",
      "site_id": "BpCTBMRARBefUrprildVqw",
      "group_id": "California",
      "site_name": "site name",
      "start_time": "2021-10-08T16:12:04Z",
      "answer_time": "2021-10-08T16:12:04Z",
      "end_time": "2021-10-08T16:12:15Z",
      "event": "outgoing",
      "result": "answered",
      "result_reason": "answered_by_other",
      "device_private_ip": "",
      "device_public_ip": "",
      "operator_ext_number": "3456",
      "operator_ext_id": "NN9rA4fZSsScB2YiCqw7Ig",
      "operator_ext_type": "user",
      "operator_name": "operator name",
      "press_key": "3",
      "segment": 0,
      "node": 0,
      "is_node": 0,
      "recording_id": "c71b360f6e774e3aa101453117b7e1a7",
      "recording_type": "automatic",
      "hold_time": 20,
      "waiting_time": 20,
      "voicemail_id": "6cd2da01bcaa47f58e3250a575c5f2bf"
    }
  ]
}