Difference between revisions of "Get the List of Voicemail Details"

From docs
Jump to: navigation, search
(→‎Successful Response (200))
(→‎Successful Response (200))
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
== [[Mobile_API]] »Get Recorded Voicemail Details ==
+
== [[Mobile_API]] »Get Voicemail List ==
  
 
=== Base URL ===
 
=== Base URL ===
Line 5: Line 5:
  
 
=== Endpoint ===
 
=== Endpoint ===
−
/api/voicemail/recorded/{phone_number}
+
/api/voicemail/list
  
 
=== Purpose ===
 
=== Purpose ===
−
Retrieves the recorded greeting/voicemail file details for a company Twilio phone number. Returns the recording identifier and a media URL when a voicemail recording is available for that number.
+
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 ===
 
=== HTTP Method ===
Line 26: Line 26:
  
 
==== Path Parameters ====
 
==== Path Parameters ====
 +
None.
 +
 +
==== Query Parameters ====
 
{| class="wikitable"
 
{| class="wikitable"
 
! Parameter !! Type !! Required !! Description
 
! Parameter !! Type !! Required !! Description
 
|-
 
|-
−
| phone_number || string || Yes || Twilio phone number whose recorded voicemail details should be retrieved
+
| page || integer || No || Page number for pagination (default: 1). Page size is 10
 
|}
 
|}
−
 
−
==== Query Parameters ====
 
−
None.
 
  
 
==== Request Body ====
 
==== Request Body ====
Line 40: Line 40:
 
=== cURL Example for Android ===
 
=== cURL Example for Android ===
  
−
<pre> curl --location 'https://apimobile.callproof.com/api/voicemail/recorded/YOUR_PHONE_NUMBER' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre>
+
<pre> curl --location 'https://apimobile.callproof.com/api/voicemail/list?page=1' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre>
  
 
=== cURL Example for iOS ===
 
=== cURL Example for iOS ===
  
−
<pre> curl --location 'https://apimobile.callproof.com/api/voicemail/recorded/YOUR_PHONE_NUMBER' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre>
+
<pre> curl --location 'https://apimobile.callproof.com/api/voicemail/list?page=1' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre>
  
 
=== Successful Response (200) ===
 
=== Successful Response (200) ===
−
Returns recorded voicemail details for the phone number. If no matching number/recording is found, <code>data</code> may be an empty array.
+
Returns a paginated list of voicemail recordings.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 58: Line 58:
 
| company_id || integer || Identifier of the authenticated user’s company
 
| company_id || integer || Identifier of the authenticated user’s company
 
|-
 
|-
−
| data || array || Recorded voicemail details (see below)
+
| 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
 
| uri || string || Requested resource URI
Line 67: Line 95:
 
! Field !! Type !! Description
 
! Field !! Type !! Description
 
|-
 
|-
−
| id || integer || Unique identifier of the Twilio phone number record
+
| 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: <code>m/d/Y</code>)
 +
|-
 +
| call_time || string || Call time in the user’s timezone (format: <code>g:i A</code>)
 +
|-
 +
| recording_url || string || URL of the voicemail recording
 
|-
 
|-
−
| url || string || Full media URL of the recorded voicemail file
+
| image || string || Contact/person image URL, when available
 
|}
 
|}
  
Line 76: Line 122:
 
! Status Code !! Meaning
 
! Status Code !! Meaning
 
|-
 
|-
−
| 400 || Bad Request – recorded voicemail details could not be retrieved
+
| 400 || Bad Request – voicemail list could not be retrieved
 
|-
 
|-
 
| 401 || Unauthorized – missing, invalid, or expired Bearer token
 
| 401 || Unauthorized – missing, invalid, or expired Bearer token
 
|}
 
|}
  
−
* '''400''' – An error occurred while retrieving recorded voicemail details (for example, "Error while retrieving  the recorded voicemail messages list").
+
* '''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.
 
* '''401''' – Authentication failed or the access token is missing/expired.

Latest revision as of 06:32, 21 July 2026

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.
Retrieved from "http://docs.callproof.com/index.php?title=Get_the_List_of_Voicemail_Details&oldid=2731"