Call History API migration

In December 2023, Zoom Phone API introduced new endpoints to replace the legacy Call Logs system. The legacy Call Logs APIs (v1) will be fully deprecated in May 2026. We previously communicated this change and are now extending the deprecation date to May 2026 to better accommodate developer needs.

Key Migration Endpoints Two new major endpoints are at the core of the migration:

  • Get account’s call history API: offers comprehensive summaries of all inbound and outbound calls across an account — available to administrators via account-level OAuth apps with the necessary scopes.
  • Get call history API: provides deeper, granular logs of the call path. (Note: This endpoint was previously called Get call path and has been renamed for improved clarity and consistency.)

Based on developer feedback, Zoom has enhanced these endpoints and introduced a refreshed version of the Call History APIs with greater clarity, consistency, and flexibility. Use the Zoom Phone Migration guide to start migrating and to learn more about this process.

Added

  • New Call Logs APIs:
    • GET /v2/phone/call_history/{callHistoryUuid}
    • GET /v2/phone/call_element/{callElementId}
    • GET /v2/accounts/{accountId}/phone/call_element/{callElementId}
    • GET /v2/accounts/{accountId}/phone/call_history/{callHistoryUuid}

Enhancements

Recordings APIs

  • Added a new call_element_id field to the response of:
    • GET /v2/phone/call_logs/{id}/recordings
    • GET /v2/accounts/{accountId}/phone/call_logs/{id}/recordings
    • GET /v2/phone/users/{userId}/recordings
    • GET /v2/accounts/{accountId}/phone/users/{userId}/recordings
    • GET /v2/accounts/{accountId}/phone/recordings
    • GET /v2/phone/recordings

Voicemails APIs

  • Added a new call_element_id field to the response of:
    • GET /v2/accounts/{accountId}/phone/voice_mails/{voicemailId}
    • GET /v2/phone/voice_mails/{voicemailId}
    • GET /v2/accounts/{accountId}/phone/users/{userId}/call_logs/{id}/voice_mail
    • GET /v2/phone/users/{userId}/call_logs/{id}/voice_mail
    • GET /v2/accounts/{accountId}/phone/voice_mails
    • GET /v2/phone/voice_mails
    • GET /v2/accounts/{accountId}/phone/users/{userId}/voice_mails
    • GET /v2/phone/users/{userId}/voice_mails

Call Logs APIs

  • Added a new call_history response field to:

    • GET /v2/phone/call_history
    • GET /v2/accounts/{accountId}/phone/call_history

  • Added a new call_elements response field to:

    • GET /v2/phone/users/{userId}/call_history/sync
    • GET /v2/accounts/{accountId}/phone/users/{userId}/call_history/sync
    • GET /v2/accounts/{accountId}/phone/users/{userId}/call_history

Webhook Events

New webhooks

If your application currently subscribes to the earlier call-history webhooks, we recommend reviewing your subscriptions and switching to the following events where appropriate.

  • phone.call_element_deleted
  • phone.callee_call_element_completed
  • phone.caller_call_element_completed

Deprecated webhooks

  • phone.call_history_deleted
  • phone.callee_call_history_completed
  • phone.caller_call_history_completed
  • phone.call_log_deleted
  • phone.call_log_permanently_deleted
  • phone.callee_call_log_completed
  • phone.caller_call_log_completed

Enhancements

  • Added a new call_element_id field to webhook payloads for:
    • phone.voicemail_transcript_completed
    • phone.recording_completed_for_access_member
    • phone.voicemail_received
    • phone.recording_completed
    • phone.voicemail_received_for_access_member