List call logs - Zoom API

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

{ "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.

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

默认值:

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

可选

page_size

integer

可选

The number of records returned within a single call.

string

可选

End date for the report in yyyy-mm-dd format.

total_records

integer

可选

The total number of records available across all pages.