GET /report/telephone

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:

Servers

Query parameters

Name Type Required Description
to String Yes

End date.

page_number Integer No

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.

Default value: 1

page_size Integer No

The number of records returned within a single API call.

Default value: 30

type String No

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

Valid values:

  • "3"
  • "1"

Default value: "1"

next_page_token String No

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.

from String Yes

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.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.