Get operation logs report
GET {{baseUrl}}/phone/reports/operationlogs?from=2020-11-01&to=2021-12-31&category_type=all&page_size=30&next_page_token=BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2
The Phone System operation logs report allows account owners and admins to view monthly Zoom phone related admin operation details. Use this API to retrieve the Phone System Operation Logs Report. Account owners and admins can also access this information by logging into their Zoom accounts and navigating to Phone System Operation Logs.
Scopes: phone:read:admin, phone:write:admin
Rate Limit Label: Heavy
Prerequisites:
* Account must be enrollled in Pro or a higher plan
* Account must be enrolled in a Zoom Phone plan
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 within the 24 hours. | |
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. | |
category_type
|
string | Filter the response by the category of the action performed. By default, the value of this field is "all" and thus, the response will include log of all operations for the defined period.<br><br>To only include response for a specific category type, provide a value for `category_type` from this [table](https://marketplace.zoom.us/docs/api-reference/other-references/phone-operation-categories). | |
page_size
|
number | The number of records returned within a single API 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
| {
"next_page_token": "BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2",
"page_size": 20,
"operation_logs": [
{
"action": "ADD",
"category_type": "Phone Number",
"operation_detail": "Add BYOC +86 182 5188 5564",
"operator": "user@test.com",
"time": "2022-02-01T02:36:14Z"
},
{
"action": "ADD",
"category_type": "Phone Number",
"operation_detail": "Add BYOC +86 182 5188 5564",
"operator": "user@test.com",
"time": "2022-02-01T02:36:14Z"
}
]
} |
ENDPOINTS