---
title: "List voicemails"
method: GET
path: "/voicemails"
tags: ["Voicemail"]
---

# List voicemails

`GET /voicemails`

## Request

- Base URL: `https://HOSTNAME:8887/api`
- URL: `https://HOSTNAME:8887/api/voicemails`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/docs/voicemails/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a collection of voicemails.

## Query parameters

- `filter` string
- `search` string
- `orderby` string
- `skip` integer
- `top` integer

## Response `200`

OK

- object
  - `count` integer: Total number of resource.
  - `items` object[]
    - `id` string: The unique ID of the resource.
    - `sender` string: The sender number of the voicemail.
    - `created_at` string, date_time: The RFC 3339 format is defined by The date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), for example, 2017-07-21T17:32:28Z
    - `duration` integer: The playback time (in seconds).
    - `status` 'READ' | 'UNREAD': Status of the voicemail includes: - `READ`: read mail - `UNREAD`: unread mail
    - `file_name` string: The name of the file.
    - `file_size` integer: The file size in bytes.
    - `file_url` string: The relative path to file url for file downloading.

## Other responses

- `4XX`: Error

---

[API](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api.md) - [All operations](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/revisions/577415d4a3d5?raw)