Get user's call logs

Retrieve a zoom phone user's call logs.

Scopes: phone:read, phone:read:admin
Rate Limit Label: Heavy
Prerequisite:

Business or Enterprise account

A Zoom Phone license

{ "call_logs": [ { "call_type": "voip", "callee_name": "somename", "callee_number": "34567889", "callee_number_type": "2", "caller_name": "ullamconame", "caller_number": "12345678", "caller_number_type": "1", "date_time": "2019-05-19T20:00:00Z", "direction": "inbound", "duration": 18677470, "id": "sjbkfdsbfsdf", "result": "no_answer" } ], "from": "2019-05-19", "page_count": 0, "page_number": 1, "page_size": 30, "to": "2019-05-20", "total_records": 0 }

请求参数

Path 参数

userId

string

必需

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

Query 参数

page_size

integer

可选

The number of records returned within a single API call.

<= 300

默认值:

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.

必需

type

enum<string>

可选

枚举值:

allmissed

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.

phone_number

string

可选

Filter API responses to include call logs of only the phone number defined in this field.

time_type

enum<string>

可选

Enables you to sort call logs by start or end time. Choose the sort time value. Values include startTime or endTime.

枚举值:

startTimeendTime

默认值:

startTime

返回响应

🟢200**HTTP Status code:** `200` User's call logs returned.

application/json

Body

Phone User Call Logs

call_logs

array [object {26}]

Call Log

可选

accepted_by

object

可选

Indicates who accepted the call.

call_id

string

可选

Unique identifier of the phone call.

callee_name

string

可选

Contact name of callee

callee_number

string

可选

Number of callee

callee_number_type

string

可选

Type of callee's number. 1 - internal | 2 - external

caller_name

string

可选

Contact name of caller

caller_number

string

可选

Number of caller

caller_number_type

string

可选

Type of caller's number. 1 - internal | 2 - external

charge

string

可选

Billing charge for the call.

client_code

string

可选

Client code.

date_time

string

可选

Start time of the call

direction

string

可选

Direction of the call. "inbound" | "outbound"

duration

integer

可选

Duration of the call in seconds.

forwarded_by

object

可选

Indicates where the call was forwarded from.

forwarded_to

object

可选

Indicates who the call was forwarded to.

has_recording

boolean

可选

Whether the call has a recording or not.

has_voicemail

boolean

可选

Whether the call has voicemail or not.

string

可选

Call Log ID

outgoing_by

object

可选

path

string

可选

Path of the call log.

rate

string

可选

Billing rate for the call.

recording_type

string

可选

Recording type.

1 - On-demand recording.

2 - Automatic recording.

result

string

可选

Result of the call. "call_connected" | "recorded" | "no_answer"

site

object

可选

user_id

string

可选

User ID or user email.

waiting_time

integer

可选

Waiting time for the call, in seconds.

from

string

可选

Date from which you would like to view the logs.

next_page_token

string

可选

page_count

integer

可选

Total number of pages

page_size

integer

可选

The number of records returned within a single API call for each page.

string

可选

Date up to which you would like to view the phone log.

total_records

integer

可选

The total number of records returned.

🔵300**Error Code:** `300`<br> User does not belong to this account.

🟠404**HTTP Status code:** `404` **Error Code:** `300`<br> User does not exist: {userId}.