Zoom Public API Documentation
List call logs
GET {{baseUrl}}/phone/metrics/call_logs?from=2021-12-01&to=2021-12-31&site_id=SQv52YtkRLC2dwrDdYtGsA&quality_type=good&page_size=30&next_page_token=T6WMY4fJBIAlxPUiqRtwvQS9dvsq8AoRam2
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: Rate Limit Label: phone:read:admin, phone:write:adminHeavy
Body
PARAM
| Key | Datatype | Required | Description |
from
|
string | Start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data at once. If unspecified, returns data from the past 30 days. | |
to
|
string | **Required** only when the `from` parameter is specified. End time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, the same format as the `from` parameter. | |
site_id
|
string | Unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites). 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
|
number | The number of records returned within a single call. | |
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. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"call_logs": [
{
"call_id": "7081466125443483485",
"callee": {
"codec": "ES8311",
"device_private_ip": "10.100.111.237",
"device_public_ip": "38.99.100.2",
"device_type": "MAC_Client",
"extension_number": "100994",
"headset": "Edifier",
"isp": "Cogent Communications",
"microphone": "+12053194087",
"phone_number": "+12053194087",
"site_id": "ZNWikLeVSjuaMvUoxFqCuw"
},
"caller": {
"codec": "ES8311",
"device_private_ip": "10.100.111.232",
"device_public_ip": "38.99.100.3",
"device_type": "MAC_Client",
"extension_number": "100152",
"headset": "Edifier",
"isp": "Cogent Communications",
"microphone": "+12053194087",
"phone_number": "+12053194087",
"site_id": "ZNWikLeVSjuaMvUoxFqCuw"
},
"date_time": "2021-04-01T02:59:32Z",
"direction": "internal",
"duration": 50923916,
"mos": "4.5"
},
{
"call_id": "7081466125443483485",
"callee": {
"codec": "ES8311",
"device_private_ip": "10.100.111.237",
"device_public_ip": "38.99.100.2",
"device_type": "MAC_Client",
"extension_number": "100994",
"headset": "Edifier",
"isp": "Cogent Communications",
"microphone": "+12053194087",
"phone_number": "+12053194087",
"site_id": "ZNWikLeVSjuaMvUoxFqCuw"
},
"caller": {
"codec": "ES8311",
"device_private_ip": "10.100.111.232",
"device_public_ip": "38.99.100.3",
"device_type": "MAC_Client",
"extension_number": "100152",
"headset": "Edifier",
"isp": "Cogent Communications",
"microphone": "+12053194087",
"phone_number": "+12053194087",
"site_id": "ZNWikLeVSjuaMvUoxFqCuw"
},
"date_time": "2021-04-01T02:59:32Z",
"direction": "internal",
"duration": 76394165,
"mos": "4.5"
}
],
"from": "2021-03-31",
"next_page_token": "T6WMY4fJBIAlxPUiqRtwvQS9dvsq8AoRam2",
"page_size": 30,
"to": "2021-04-01",
"total_records": 20
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/metrics/call_logs?from=2021-12-01&to=2021-12-31&site_id=SQv52YtkRLC2dwrDdYtGsA&quality_type=good&page_size=30&next_page_token=T6WMY4fJBIAlxPUiqRtwvQS9dvsq8AoRam2?from=2021-12-01&to=2021-12-31&site_id=SQv52YtkRLC2dwrDdYtGsA&quality_type=good&page_size=30&next_page_token=T6WMY4fJBIAlxPUiqRtwvQS9dvsq8AoRam2' -H 'Accept: application/json'
ENDPOINTS