Get telephone reports

The telephone report allows you to view who dialed into meetings via phone (Audio Conferencing or SIP Connected Audio) and which number they dialed into and other details. Use this API to get telephone report for a specified period of time.

Scopes: report:read:admin

Rate Limit Label: Heavy
Prerequisites:

Pro or higher plan.

{ "from": "2019-06-20", "to": "2019-07-20", "page_count": 1, "page_number": 1, "page_size": 30, "total_records": 1, "telephony_usage": [ { "meeting_id": 00000, "phone_number": "000002001", "host_name": "minim c", "host_email": "nadhkasdg@jdskfhdsf.hjhj", "dept": "Billing", "start_time": "2019-07-15T23:24:52Z", "end_time": "2019-07-15T23:30:19Z", "duration": 6, "total": 11, "country_name": "nulla laboris cillum", "meeting_type": "voluptate", "call_in_number": "occaecat et reprehenderit" } ] }

请求参数

Query 参数

type

enum<string>

可选

Audio types:
1 - Toll-free Call-in & Call-out.
2 - Toll
3 - SIP Connected Audio

枚举值:

默认值:

from

string <date>

必需

Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.

string <date>

End date.

必需

page_size

integer

可选

The number of records returned within a single API call.

<= 300

默认值:

page_number

integer

可选

Deprecated - This field has been deprecated and we will stop supporting it completely in a future release. Please use "next_page_token" for pagination instead of this field.

The page number of the current page in the returned records.

默认值:

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**HTTP Status Code:** `200`<br> Telephone report returned.<br> This is only available for paid account:{accountId}.<br> The requested report cannot be generated for this account because this account has not subscribed to toll-free audio conference plan.<b

application/json

Body

from

string <date>

可选

Start date for this report.

next_page_token

integer

可选

The page number of the current results.

默认值:

page_count

integer

可选

The number of pages returned for the request made.

page_size

integer

可选

The number of records returned with a single API call.

<= 300

默认值:

string <date>

可选

End date for this report.

total_records

integer

可选

The total number of all the records available across pages.

telephony_usage

array [object {17}]

可选

Array of telephony objects.

call_in_number

string

可选

Caller's call-in number.

country_name

string

可选

Country name.

dept

string

可选

User department.

duration

integer

可选

Call leg duration

end_time

string <date-time>

可选

Call leg end time

host_email

string

可选

User email.

host_id

string

可选

The user ID of the meeting host.

host_name

string

可选

User display name.

meeting_id

integer <int64>

可选

Meeting ID: Unique identifier of the meeting in "long" format(represented as int64 data type in JSON), also known as the meeting number.

meeting_type

string

可选

Meeting type.

phone_number

string

可选

Toll-free telephone number.

rate

number

可选

Calling rate for the telephone call.

signaled_number

string

可选

The number that is signaled to Zoom.

start_time

string <date-time>

可选

Call leg start time

total

number

可选

Total cost (USD) for Call Out. Calculated as plan rate by duration.

type

enum<string>

可选

Call type.

枚举值:

toll-freecall-outcall-inUS toll-numberglobal toll-numberpremiumpremium call-in

uuid

string

可选

Meeting UUID.