Get account's call logs

GET

/phone/call_logs

Phone

Retrieve call logs for an account.

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

Business or Enterprise account

A Zoom Phone license

Account Owner and a role with Zoom Phone Management

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://api.zoom.us/v2/phone/call_logs'

响应示例

200 - response

{
  "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",
      "owner": {
        "extension_number": 1009,
        "id": "29QVgYBGRmOM5VlC0DmLgg",
        "name": "Not_Delete_CallQueue_Recording",
        "type": "callQueue"
      },
      "result": "no_answer"
    }
  ],
  "from": "2019-05-19",
  "page_count": 0,
  "page_number": 1,
  "page_size": 30,
  "to": "2019-05-20",
  "total_records": 0
}

请求参数

Query 参数

page_size

integer

可选

The number of records returned within a single API call.

<= 300

默认值:

from

string

可选

Start date from which you would like to get the call logs. The start date should be within past six months.

The API only returns data pertaining to a month. Thus, the date range(defined using "from" and "to" fields) for which the call logs are to be returned must not exceed a month.

string

可选

The end date upto which you would like to get the call logs for. The end date should be within past six months.

type

string

可选

The type of the call logs. The value can be either "all" or "missed".

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.

path

string

可选

Filter the API response by path of the call. The value of this field can be one of the following: voiceMail, message, forward, extension, callQueue, ivrMenu, companyDirectory, autoReceptionist, contactCenter, disconnected, commonAreaPhone,
pstn, transfer, sharedLines, sharedLineGroup, tollFreeBilling, meetingService, parkPickup,
parkTimeout, monitor, takeover, sipGroup

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

site_id

string

可选

Unique identifier of the site. Use this query parameter if you have enabled multiple sites and would like to filter the response of this API call by call logs of a specific phone site.

返回响应

🟢200**HTTP Status Code:** `200`<br> Account's call logs returned.

application/json

Body

Account Call Logs

call_logs

array [object {24}]

Call Log

可选

answer_start_time

string <date-time>

可选

GMT date and time at which the inbound call was answered. The value of this field is in yyyy-MM-dd'T'HH:mm:ss'Z' format.

call_id

string

可选

Unique identifier of the phone call.

call_type

enum<string>

可选

The type of call:
*voip (Voice over IP)
*pstn (Public Switched Telephone Network)
*tollfree
*international
*contactCenter

枚举值:

voippstntollfreeinternationalcontactCenter

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.

string

可选

Call Log ID

owner

object

可选

path

string

可选

Path of the call.

rate

string

可选

Billing rate for the call.

recording_id

string

可选

Unique identifier of the call recording.

recording_type

enum<string>

可选

Type of call recording:
1 OnDemand
2 Automatic

枚举值:

result

string

可选

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

site

object

可选

user_id

string

可选

User ID of the call log owner.

waiting_time

string

可选

Duration that a call queue member takes to answer a call from the time it started ringing. The value of the duration is 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.

🟠404**HTTP Status Code:** `404`<br> **Error Code:** `3001`<br> Error retrieving call logs.

修改于 2024-04-24 09:06:48

Add BYOC phone numbers

List calling plans