Get user's voicemails

Retrieve a user's Zoom Phone voicemails.

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

Business or Enterprise account

A Zoom Phone license

{ "page_count": 0, "page_number": 1, "page_size": 30, "total_records": 1, "voice_mails": [ { "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", "download_url": "ani_maborumu7labojgde.com", "duration": "18:07", "id": "Excepteur", "status": "read" } ] }

请求参数

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

默认值:

status

enum<string>

可选

Status of the voice mail

枚举值:

allreadunread

默认值:

all

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.

from

string <date>

可选

Start date for the query in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the response includes only one month worth of voicemail data. The month defined should fall within the last six months.

string <date>

End date.

必需

返回响应

🟢200**HTTP Status Code:** `200`<br> User object returned.

application/json

Body

Phone User Voice Mails

from

string <date>

可选

Start date for the query.

next_page_token

string

可选

page_count

integer

可选

Total number of page

page_size

integer

可选

Size of each page

string <date>

End date.

可选

total_records

integer

可选

Total number of records

voice_mails

array [object {11}]

可选

Voice Mails

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

date_time

string

可选

Date the voice mail started

download_url

string

可选

Download url of attachment

duration

string

可选

Duration of the voice mail, formatted as hh:mm:ss, for example: 06:30 for six minutes and thirty seconds.

string

可选

Id of voice mail

status

enum<string>

可选

Status of the voice mail. Can be either 'read' or 'unread'

枚举值:

readunread

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

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