获取电话报告

电话报告允许您查看谁通过电话拨入会议 (音频会议或SIP连接的音频) 以及他们拨入的号码和其他详细信息。使用此API获取指定时间段内的电话报告。

** 先决条件: **

Pro或更高的计划。

** 范围: ** '报告: master'

** [速率限制标签](https://marketplace.zoom.us/docs/api参考/速率限制 # 速率限制):** “沉重”

请求参数

Path 参数

accountId

string

帐户的唯一标识符。

必需

Query 参数

type

string

可选

音频类型:
'1'-免费来电和来电。
'2'-收费

'3'-SIP连接的音频

query_date_type

string

可选

要查询的日期类型。

'start_time'-按调用开始时间查询。

'end_time'-按呼叫结束时间查询。

'meeting_start_time'-按会议开始时间查询。

'meeting_end_time'-按会议结束时间查询。

此值默认为 “start_time”。

from

string

必需

以 'yyyy-mm-d' 格式的开始日期。“从” 和 “到” 参数定义的日期范围应该只有一个月，因为报告一次只包括一个月的数据。

string

结束日期。

必需

page_size

integer

可选

单个API调用中返回的记录数。

page_number

integer

可选

返回记录中当前页面的页码。如果 “query_date_type” 参数为 “meeting_start_time” 或 “meeting_end_time” 值，则此字段 ** 不可用 **。

此字段已弃用。使用 “next_page_token” 查询参数进行分页。

next_page_token

string

可选

下一页标记用于通过大型结果集进行分页。每当可用结果集超过当前页面大小时，将返回下一页令牌。此令牌的有效期为15分钟。

返回响应

🟢200** HTTP状态代码: ** '200' 电话报告返回。这仅适用于付费帐户:{accountId}。无法为此帐户生成请求的报告，因为此帐户尚未订阅免费音频会议计划。必须启用收费报告功能才能执行此操作。请联系Zoom支持团队以获得帮助。

application/json

Body

next_page_token

string

可选

下一页标记用于通过大型结果集进行分页。每当可用结果集超过当前页面大小时，将返回下一页令牌。此令牌的有效期为15分钟。

示例值:

w7587w4eiyfsudgk

total_records

integer

可选

跨页可用的所有记录的总数。如果 “query_date_type” 参数是 “meeting_start_time” 或 “meeting_end_time” 值，则此字段 ** 不 ** 返回。

示例值:

from

string <date>

此报告的开始日期。

可选

示例值:

2019-06-20

telephony_usage

array [object {17}]

电话对象的数组。

可选

meeting_id

integer <int64>

可选

会议ID: 会议的唯一标识符，格式为 “** long **” (在JSON中表示为int64数据类型)，也称为会议编号。

示例值:

94908911701

end_time

string <date-time>

呼叫段结束时间

可选

示例值:

2022-03-15T07:42:22Z

meeting_type

string

会议类型。

可选

示例值:

Meeting

dept

string

用户部门。

可选

示例值:

type

enum<string>

呼叫类型。

可选

枚举值:

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

示例值:

call-out

uuid

string

会议UUID。

可选

示例值:

4444AAAiAAAAAiAiAiiAii==

host_id

string

可选

会议主持人的用户ID。

示例值:

_Rn_hal7ToG5p0AWwIIsjQ

duration

integer

呼叫段持续时间

可选

示例值:

start_time

string <date-time>

呼叫段开始时间

可选

示例值:

2022-03-15T07:40:46Z

total

number

可选

调出的总费用 (美元)。按持续时间计算为计划费率。

示例值:

0.03

rate

number

电话呼叫的呼叫率。

可选

示例值:

0.03

call_in_number

string

来电者的电话号码。

可选

示例值:

ZoomGW

signaled_number

string

可选

发出Zoom信号的数字。

示例值:

+1 8243

country_name

string

国家名称。

可选

示例值:

phone_number

string

免费电话号码。

可选

示例值:

+1 8243

host_name

string

用户显示名称。

可选

示例值:

Jill Chill

host_email

string

用户电子邮件。

可选

示例值:

jchill@example.com

string <date>

此报告的结束日期。

可选

示例值:

2019-07-20

page_count

integer

可选

为发出的请求返回的页数。如果 “query_date_type” 参数是 “meeting_start_time” 或 “meeting_end_time” 值，则此字段 ** 不 ** 返回。

示例值:

page_size

integer

可选

通过单个API调用返回的记录数。

示例值:

示例

{
  "next_page_token": "w7587w4eiyfsudgk",
  "total_records": 1,
  "from": "2019-06-20",
  "telephony_usage": [
    {
      "meeting_id": 94908911701,
      "end_time": "2022-03-15T07:42:22Z",
      "meeting_type": "Meeting",
      "dept": "HR",
      "type": "toll-free",
      "uuid": "4444AAAiAAAAAiAiAiiAii==",
      "host_id": "_Rn_hal7ToG5p0AWwIIsjQ",
      "duration": 2,
      "start_time": "2022-03-15T07:40:46Z",
      "total": 0.03,
      "rate": 0.03,
      "call_in_number": "ZoomGW",
      "signaled_number": "+1 8243",
      "country_name": "US",
      "phone_number": "+1 8243",
      "host_name": "Jill Chill",
      "host_email": "jchill@example.com"
    }
  ],
  "to": "2019-07-20",
  "page_count": 1,
  "page_size": 30
}

请求参数

示例代码

返回响应