Report_Telephony_usageTelephone |
Retrieve telephone reportRetrieve telephone report for a specified period <aside>Toll Report option would be removed.</aside>.
Catalog: Zoom
Schema: Reports
This is a read-only table function. The Zoom API may not support changing the data or the Invantive SQL driver for Zoom does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Zoom API.
Select Zoom API URL: /report/telephone
Insert Zoom API URL: /report/telephone
Update Zoom API URL: /report/telephone
Delete Zoom API URL: /report/telephone
Field Selection Method: NotRequired
Base Path: telephony_usage[*]
Select Zoom API Operation: get /report/telephone
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function Report_Telephony_usageTelephone. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be treated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example with `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.
Name |
Data Type |
Required |
Default Value |
Documentation |
---|---|---|---|---|
from |
datetime |
☑ |
|
Start Date |
page_number |
int64 |
☐ |
1 |
Current page number of returned records |
page_size |
int64 |
☐ |
30 |
The number of records returned within a single API call |
to |
datetime |
☑ |
|
End Date |
type |
string |
☐ |
1 |
Audio type (Values: 1) |
Table Function Columns
The columns of the table function Report_Telephony_usageTelephone are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
---|---|---|---|---|
call_in_number |
string |
|
☐ |
Call in number |
country_name |
string |
|
☐ |
Country Name |
dept |
string |
|
☐ |
User department |
duration |
int64 |
|
☐ |
Meeting duration |
end_time |
datetime |
|
☐ |
Meeting end time |
from |
datetime |
|
☐ |
Start date for this report |
host_email |
string |
|
☐ |
User email |
host_name |
string |
|
☐ |
User display name |
meeting_id |
int64 |
|
☐ |
Meeting ID |
meeting_type |
string |
|
☐ |
Meeting Type |
page_count |
int64 |
|
☐ |
The number of items returned on this page |
page_number |
int64 |
|
☐ |
The page number of current results |
page_size |
int64 |
|
☐ |
The number of records returned within a single API call |
phone_number |
string |
|
☐ |
Telephone Number |
start_time |
datetime |
|
☐ |
Meeting start time |
to |
datetime |
|
☐ |
End date for this report |
total_records |
int64 |
|
☐ |
The number of all records available across pages |
total |
decimal |
|
☐ |
Total |
16-06-2022 17:21 Version 22.1.46-BETA+3385