Zoom API
  1. Dashboards
Zoom API
  • Accounts
    • List sub accounts
      GET
    • Create a sub account
      POST
    • Disassociate a sub account
      DELETE
    • Get sub account details
      GET
    • Get locked settings
      GET
    • Update locked settings
      PATCH
    • Get managed domains
      GET
    • Update options
      PATCH
    • Update the account owner
      PUT
    • Get settings
      GET
    • Update settings
      PATCH
    • Delete virtual background files
      DELETE
    • Upload virtual background files
      POST
    • Get trusted domains
      GET
  • Billing
    • Get billing information
    • Update billing information
    • List billing invoices
    • Get invoice details
    • Get plan Information
    • Subscribe plans
    • Subscribe additional plan
    • Update an additional plan
    • Cancel additional plans
    • Update a base plan
    • Cancel a base plan
    • Get plan usage
    • Download an invoice file
  • Phone
    • Update BYOC settings
    • Set up a Zoom Phone account
    • Assign SIP trunks
    • Update SIP trunk details
    • Add BYOC phone numbers
    • Get account's call logs
    • List calling plans
    • Change main company number
    • List phone numbers
    • Get phone number details
    • Update phone number details
    • Get call recordings
    • List setting templates
    • Add a setting template
    • Get setting template details
    • Update a setting template
    • List BYOC SIP trunks
    • List phone users
    • Get user's profile
    • Update user's profile
    • Get user's call logs
    • Delete a user's call log
    • Assign calling plan to a user
    • Unassign user's calling plan
    • Assign phone number to user
    • Unassign phone number
    • Get user's recordings
    • Get user's settings
    • Remove shared access
    • Update shared access
    • Set up shared access
    • Get user's voicemails
    • Delete a voicemail
  • Cloud Recording
    • List recordings of an account
    • List archived files
    • Delete meeting recordings
    • Get meeting recordings
    • List recording registrants
    • Create a recording registrant
    • Get registration questions
    • Update registration questions
    • Update registrant's status
    • Get meeting recording settings
    • Update meeting recording settings
    • Recover meeting recordings
    • Delete a meeting recording file
    • Recover a single recording
    • List all recordings
  • SIP Connected Audio
    • List internal call-out countries
    • Add internal call-out countries
    • Delete internal call-out country
    • List internal numbers
    • Add internal numbers
    • Delete an internal number
    • Delete all numbers
    • Assign numbers
    • Assign SIP trunk configuration
    • List SIP trunks
    • Assign SIP trunks
    • Delete a SIP trunk
    • List SIP trunk numbers
  • Users
    • Switch a user's account
    • List users
    • Create users
    • Check a user email
    • Get user's ZAK
    • Check a user's PM room
    • Delete a user
    • Get a user
    • Update a user
    • Delete user assistants
    • List user assistants
    • Add assistants
    • Delete a user assistant
    • Update a user's email
    • Update a user's password
    • Get user permissions
    • Upload a user's profile picture
    • Update a user's presence status
    • Delete user schedulers
    • List user schedulers
    • Delete a scheduler
    • Get user settings
    • Update user settings
    • Delete virtual background files
    • Upload virtual background files
    • Update user status
    • Revoke a user's SSO token
    • Get a user token
  • Chat Channels
    • Delete a channel
    • Get a channel
    • Update a channel
    • Leave a channel
    • Join a channel
    • Remove a member
    • List user's channels
    • Create a channel
  • Contacts
    • List user's contacts
    • Get user's contact details
    • Search company contacts
  • Chat Channels (Account-level)
    • Delete a channel
    • Get a channel
    • Update a channel
    • List channel members
    • Invite channel members
    • Remove a member
  • Chat Messages
    • List user's chat messages
    • Send a chat message
    • Delete a message
    • Update a message
  • Groups
    • List groups
    • Create a group
    • Delete a group
    • Get a group
    • Update a group
    • Get locked settings
    • Update locked settings
    • List group members
    • Add group members
    • Delete a group member
    • Update a group member
    • Get a group's settings
    • Update a group's settings
    • Delete virtual background files
    • Upload virtual background files
  • Devices
    • List H.323/SIP devices
    • Create a H.323/SIP device
    • Delete a H.323/SIP device
    • Update a H.323/SIP device
  • Chatbot Messages
    • Send chatbot messages
    • Delete a chatbot message
    • Edit a chatbot message
  • IM Chat
    • Get IM chat sessions
    • Get IM chat messages
    • Send IM messages
    • Get user’s IM messages
  • IM Groups
    • List IM directory groups
    • Create an IM directory group
    • Delete an IM directory group
    • Retrieve an IM directory group
    • Update an IM directory group
    • List IM directory group members
    • Add IM directory group members
    • Delete an IM directory group member
  • Meetings
    • Use in-Meeting recording controls
    • Delete a meeting
    • Get a meeting
    • Update a meeting
    • Perform batch poll creation
    • Get meeting invitation
    • Get live stream details
    • Update a live stream
    • Update Live Stream Status
    • List meeting polls
    • Create a meeting poll
    • Delete a meeting poll
    • Get a meeting poll
    • Update a meeting poll
    • List meeting registrants
    • Add meeting registrant
    • List registration questions
    • Update registration questions
    • Update registrant's status
    • Delete a meeting registrant
    • Update meeting status
    • List ended meeting instances
    • List past meeting's poll results
    • Get past meeting details
    • Get past meeting participants
    • List meeting templates
    • List meetings
    • Create a meeting
  • Dashboards
    • List Zoom meetings client feedback
      GET
    • Get zoom meetings client feedback
      GET
    • List client meeting satisfaction
      GET
    • Get CRC port usage
      GET
    • Get IM metrics
      GET
    • Get top 25 Zoom Rooms with issues
      GET
    • Get issues of Zoom Rooms
      GET
    • List meetings
      GET
    • Get meeting details
      GET
    • List meeting participants
      GET
    • List meeting participants QoS
      GET
    • Get post meeting feedback
      GET
    • Get sharing/recording details
      GET
    • Get meeting participant QoS
      GET
    • List webinars
      GET
    • Get webinar details
      GET
    • Get webinar participants
      GET
    • List webinar participant QoS
      GET
    • Get post webinar feedback
      GET
    • Get sharing/recording details
      GET
    • Get webinar participant QoS
      GET
    • List Zoom Rooms
      GET
    • Get top 25 issues of Zoom Rooms
      GET
    • Get Zoom Rooms details
      GET
    • List call logs
      GET
    • Get call QoS
      GET
    • Get call details from call log
      GET
  • Deprecated API Endpoints
    • List past meeting's files
    • List past webinar files
  • Webinars
    • Get webinar absentees
    • List past webinar instances
    • List webinar participants
    • List past webinar poll results
    • List Q&A of past webinar
    • List webinar templates
    • List webinars
    • Create a webinar
    • Delete a webinar
    • Get a webinar
    • Update a webinar
    • Perform batch registration
    • Remove panelists
    • List panelists
    • Add panelists
    • Remove a panelist
    • List a webinar's polls
    • Create a webinar's poll
    • Delete a webinar poll
    • Get a webinar poll
    • Update a webinar poll
    • List webinar registrants
    • Add a webinar registrant
    • List registration questions
    • Update registration questions
    • Update registrant's status
    • Delete a webinar registrant
    • Get a webinar registrant
    • Update webinar status
    • Get webinar tracking sources
  • Phone Auto Receptionists
    • Add an auto receptionist
    • Update auto receptionist details
    • Unassign all phone numbers
    • Assign phone numbers
    • Unassign a phone number
  • Phone Blocked List
    • List blocked lists
    • Create a blocked list
    • Delete a blocked list
    • Get blocked list details
    • Update a blocked list
  • Phone Call Queues
    • List call queues
    • Create a call queue
    • Delete a call queue
    • Get call queue details
    • Update call queue details
    • Change call queue manager
    • Unassign all members
    • Add members to a call queue
    • Unassign a member
    • Unassign all phone numbers
    • Assign numbers to a call queue
    • Unassign a phone number
    • Get call queue recordings
  • Common Area Phones
    • List common area phones
    • Add a common area phone
    • Delete a common area phone
    • Get common area phone details
    • Update common area phone
  • Phone Devices
    • List devices
    • Add a device
    • Delete a device
    • Get device details
    • Update a device
  • Phone Reports
    • Get operation logs report
  • Phone Shared Line Groups
    • List shared line groups
    • Create a shared line group
    • Delete a shared line group
    • Get a shared line group
    • Update a shared line group
    • Unassign members of a shared line group
    • Add members to a shared line group
    • Unassign a member from a shared line group
    • Assign phone numbers
    • Unassign a phone number
  • Phone Site
    • List phone sites
    • Create a phone site
    • Delete a phone site
    • Get phone site details
    • Update phone site details
  • Reports
    • Get sign In / sign out activity report
    • Get cloud recording usage report
    • Get daily usage report
    • Get meeting detail reports
    • Get meeting participant reports
    • Get meeting poll reports
    • Get operation logs report
    • Get telephone reports
    • Get active/inactive host reports
    • Get meeting reports
    • Get webinar detail reports
    • Get webinar participant reports
    • Get webinar poll reports
    • Get webinar Q&A report
  • Roles
    • List roles
    • Create a role
    • Delete a role
    • Get role information
    • Update role information
    • List members in a role
    • Assign a role
    • Unassign a role
  • Rooms
    • List Zoom Rooms
    • Add a Zoom Room
    • List digital signage contents
    • Update E911 digital signage
    • Check-in or check-out of a Zoom Room
    • Delete a Zoom Room
    • Get Zoom Room profile
    • Update a Zoom Room profile
    • List Zoom Room devices
    • Change a Zoom Room's location
    • Get Zoom Room settings
    • Update Zoom Room settings
  • Rooms Account
    • Get Zoom Room account profile
    • Update Zoom Room account profile
    • Get Zoom Room account settings
    • Update Zoom Room account settings
  • Rooms Location
    • List Zoom Room locations
    • Add a location
    • Get Zoom Room location structure
    • Update Zoom Rooms location structure
    • Get Zoom Room location profile
    • Update Zoom Room location profile
    • Change the assigned parent location
    • Get location settings
    • Update location settings
  • Rooms Devices
    • Change Zoom Rooms' app version
  • SIP Phone
    • List SIP phones
    • Enable SIP phone
    • Delete SIP phone
    • Update SIP phone
  • TrackingField
    • List tracking fields
    • Create a tracking field
    • Delete a tracking field
    • Get a tracking field
    • Update a tracking field
  • TSP
    • Get account's TSP information
    • Update account's TSP information
    • List user's TSP accounts
    • Add a user's TSP account
    • Set global dial-in URL for a TSP user
    • Delete a user's TSP account
    • Get a user's TSP account
    • Update a TSP account
  • PAC
    • List a user's PAC accounts
  • Data Compliance
  • Webhooks
  • master account APIs
  1. Dashboards

List call logs

GET
/phone/metrics/call_logs
Dashboards
Call logs provide a record of all incoming and outgoing calls over Zoom Phone in an account.
Use this API to list monthly call logs metrics. You can use query parameters to filter the response by date, site and MOS(Mean Opinion Score) of the call.
Prerequisites:
Business, or Education account
Zoom Phone license

Scopes: phone:read:admin, phone:write:admin
Rate Limit Label: Heavy
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://api.zoom.us/v2/phone/metrics/call_logs'
响应示例响应示例
{
  "call_logs": [
    {
      "call_id": "600097",
      "callee": {
        "codec": "opus",
        "device_type": "Windows_Client 5.2.42619.0804",
        "extension_number": "1003",
        "headset": "Logitech USB Headset H340",
        "isp": "other",
        "microphone": "Logitech USB Headset H340",
        "phone_number": "+1200009995",
        "site_id": "8f71O86ghjIFAdQ"
      },
      "caller": {
        "codec": "opus",
        "device_type": "Windows_Client 5.2.42619.0804",
        "extension_number": "1021",
        "headset": "Logitech USB Headset H340",
        "isp": "other",
        "microphone": "Logitech USB Headset H340",
        "phone_number": "+100006180",
        "site_id": "8f71O6rWT8KFUGQmJIFAdQ"
      },
      "date_time": "2020-09-11T05:38:53Z",
      "direction": "internal",
      "duration": 75,
      "mos": "1.0"
    },
    {
      "call_id": "687000062",
      "callee": {
        "codec": "opus",
        "device_type": "Windows_Client 5.2.42619.0804",
        "extension_number": "1003",
        "headset": "Logitech USB Headset H340",
        "isp": "other",
        "microphone": "Logitech USB Headset H340",
        "phone_number": "+120123435",
        "site_id": "8f87cgmJIFAdQ"
      },
      "caller": {
        "codec": "opus",
        "device_type": "Windows_Client 5.2.42619.0804",
        "extension_number": "1021",
        "headset": "Logitech USB Headset H340",
        "isp": "other",
        "microphone": "Logitech USB Headset H340",
        "phone_number": "+100003330",
        "site_id": "8f9586mJIFAdQ"
      },
      "date_time": "2020-09-11T05:35:41Z",
      "direction": "internal",
      "duration": 71,
      "mos": "1.0"
    },
    {
      "call_id": "68798685701826",
      "callee": {
        "extension_number": "10006",
        "site_id": "DS8YB6B6TYSN8BKo0P-5ug"
      },
      "caller": {
        "codec": "opus",
        "device_type": "Windows_Client 5.2.42619.0804",
        "extension_number": "1021",
        "headset": "Logitech USB Headset H340",
        "isp": "other",
        "microphone": "Logitech USB Headset H340",
        "phone_number": "+12099990",
        "site_id": "8f71O6rWT8KFUGQmJIFAdQ"
      },
      "date_time": "2020-09-11T05:30:49Z",
      "direction": "internal",
      "duration": 67,
      "mos": "1.0"
    }
  ],
  "from": "2020-03-11",
  "next_page_token": "Dhgnfxcnxzerz",
  "page_size": 10,
  "to": "2020-09-11",
  "total_records": 3
}

请求参数

Query 参数
from
string 
可选
Start date for the report in yyyy-mm-dd format. Specify a 30 day range using the from and to parameters as the response provides a maximum of a month worth of data per API request.
to
string 
可选
End date for the report in yyyy-mm-dd format.
site_id
string 
可选
Unique identifier of the site. Use this query parameter if you have enabled multiple sites and would like to filter the response of this API call by call logs of a specific phone site.
quality_type
string 
可选
Filter call logs by voice quality. Zoom uses MOS of 3.5 as a general baseline to categorize calls by call quality. A MOS greater than or equal to 3.5 means good quality, while below 3.5 means poor quality.

The value of this field can be one of the following:
good: Retrieve call logs of the call(s) with good quality of voice.
bad: Retrieve call logs of the call(s) with good quality of voice.
all: Retrieve all call logs without filtering by voice quality.
page_size
integer 
可选
The number of records returned within a single call.
<= 100
默认值:
30
next_page_token
string 
可选
The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

返回响应

🟢200成功
application/json
Body
call_logs
array [object {7}] 
可选
Call logs.
call_id
string 
可选
Unique identifier of the phone call.
callee
object 
可选
Callee object contains information of the calee.
caller
object 
可选
Caller object contains information of the caller.
date_time
string 
可选
Date and time at which the call started.
direction
string 
可选
Direction of the call. The value of this field can be either internal or outbound.
duration
integer 
可选
Duration of the call in seconds.
mos
string 
可选
Zoom uses Mean Opinion Score (MOS) as the main measurement to report on voice quality. MOS measures voice quality on a scale of 1 to 5. A score of 1 indicates unacceptable voice quality for all users. A score of 5 is the best voice quality.
from
string 
可选
Start date for the report in yyyy-mm-dd format.
next_page_token
string 
可选
The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
page_size
integer 
可选
The number of records returned within a single call.
to
string 
可选
End date for the report in yyyy-mm-dd format.
total_records
integer 
可选
The total number of records available across all pages.

【Zoom】API开发者 微信交流群

用微信扫右侧二维码，加入【Zoom】API开发者 交流群，互助沟通

扫码加入交流群
上一页
Get Zoom Rooms details
下一页
Get call QoS
Built with