Voice Mail

From docs
Jump to: navigation, search

Mobile_API »Get Call Log Details

Base URL

https://apimobile.callproof.com

Endpoint

/api/call-log

Purpose

Retrieves a paginated call history for the authenticated user’s company. Results can be filtered by call type, date range, and search text, and are grouped by call date. Opening this list also marks the user’s unread missed-call counters as viewed.

HTTP Method

POST

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

Parameter Type Required Description
call_type integer No Call type filter: 1 = outgoing, 2 = incoming, 3 = missed
from_date date No Start date for filtering calls (used with to_date)
to_date date No End date for filtering calls (used with from_date)
search string No Search text across contact name, company, phone, notes, personnel name, and call transcription text
page integer No Page number (can also be sent as a query parameter)

cURL Example for Android

 curl --location 'https://apimobile.callproof.com/api/call-log?page=1' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "call_type": "", "from_date": "", "to_date": "", "search": "", "page": 1 }' 

cURL Example for iOS

 curl --location 'https://apimobile.callproof.com/api/call-log?page=1' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "call_type": "", "from_date": "", "to_date": "", "search": "", "page": 1 }' 

Successful Response (200)

Returns call logs grouped by date, with pagination metadata.

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 Date-grouped call log sections
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 call records
uri string Requested resource URI

data[]

Field Type Description
date string Grouped call date label (user timezone)
call_data array Calls for that date

data[].call_data[]

Field Type Description
id integer Unique identifier of the call record
call_type string Call direction/type label (for example, Outgoing, Incoming, Missed)
contact_type string Contact type name
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
contact_person_name string Person name linked to the phone, when available
contact_company_name string Company name for the contact
twilio_call_notes string Notes saved on the call
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 Recording URL when available and not a voicemail-only recording
is_voice_mail boolean Whether the call is a voicemail
image string Contact/personnel image URL when available
transcription string Call transcription/summary text when available

Error Responses

Status Code Meaning
200 Validation failed – response body uses clientStatusCode 401 with the first validation error message
400 Bad Request – call logs could not be retrieved
401 Unauthorized – missing, invalid, or expired Bearer token
  • Validation (HTTP 200, clientStatusCode 401) – Invalid from_date, to_date, call_type, or search.
  • 400 – An error occurred while retrieving call logs (for example, "Error while retrieving the twilio call log details").
  • 401 – Authentication failed or the access token is missing/expired.