Get the List of Voicemail Details
Contents
Mobile_API »Get Voicemail List
Base URL
https://apimobile.callproof.com
Endpoint
/api/voicemail/list
Purpose
Retrieves a paginated list of recorded voicemails for the authenticated user’s company. Only calls marked as voicemail with a contact, phone, and recording are returned, newest first.
HTTP Method
GET
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer access token |
Security
- Yes – Requires Bearer Token authentication.
Parameters
Path Parameters
None.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | No | Page number for pagination (default: 1). Page size is 10 |
Request Body
None.
cURL Example for Android
curl --location 'https://apimobile.callproof.com/api/voicemail/list?page=1' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
cURL Example for iOS
curl --location 'https://apimobile.callproof.com/api/voicemail/list?page=1' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Successful Response (200)
Returns a paginated list of voicemail recordings.
| Field | Type | Description |
|---|---|---|
| clientStatusCode | integer | Status indicator for the client (for example, 200) |
| user_id | integer | Identifier of the authenticated user |
| company_id | integer | Identifier of the authenticated user’s company |
| data | array | List of voicemail records (see below) |
| firstItemOnPage | integer | Index of the first item on the current page |
| lastItemOnPage | integer | Index of the last item on the current page |
| hasNextPage | boolean | Whether a next page is available |
| hasPreviousPage | boolean | Whether a previous page is available |
| isFirstPage | boolean | Whether the current page is the first page |
| isLastPage | boolean | Whether the current page is the last page |
| next_page_url | string/null | URL of the next page, when available |
| prev_page_url | string/null | URL of the previous page, when available |
| first_page_url | string | URL of the first page |
| last_page_url | string | URL of the last page |
| pageCount | integer | Total number of pages |
| pageNumber | integer | Current page number |
| pageSize | integer | Number of items per page (10) |
| totalItemCount | integer | Total number of matching voicemails |
| uri | string | Requested resource URI |
data[]
| Field | Type | Description |
|---|---|---|
| id | integer | Unique identifier of the voicemail/call record |
| contact_id | integer | Related contact identifier |
| country_code | string | Phone country/dialing code |
| contact_phone_id | integer | Related contact phone identifier |
| contact_phone | string | Phone number (digits without dashes) |
| contact_person_name | string | Name of the linked person, when available |
| contact_company_name | string | Company name for the contact |
| call_date | string | Call date in the user’s timezone (format: m/d/Y)
|
| call_time | string | Call time in the user’s timezone (format: g:i A)
|
| recording_url | string | URL of the voicemail recording |
| image | string | Contact/person image URL, when available |
Error Responses
| Status Code | Meaning |
|---|---|
| 400 | Bad Request – voicemail list could not be retrieved |
| 401 | Unauthorized – missing, invalid, or expired Bearer token |
- 400 – An error occurred while retrieving voicemails (for example, "Error while retrieving the recorded voicemail messages list").
- 401 – Authentication failed or the access token is missing/expired.
