Ashley DeBon: /* Successful Response (200) */

2026-07-21T06:13:40Z

‎Successful Response (200)

Ashley DeBon: /* Get Call Log Details */

2026-07-21T06:13:06Z

‎Get Call Log Details

Ashley DeBon: Created page with "== Get Call Log Details == === Base URL === https://apimobile.callproof.com === Endpoint === /api/call-log === Purpose === Retrieves a paginated call history for the authen..."

2026-07-21T06:12:48Z

Created page with "== Get Call Log Details == === Base URL === https://apimobile.callproof.com === Endpoint === /api/call-log === Purpose === Retrieves a paginated call history for the authen..."

New page

== 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 ===
{| class="wikitable"
! Header !! Required !! Description
|-
| Authorization || Yes || Bearer access token
|}

=== Security ===
* '''Yes''' – Requires Bearer Token authentication.

=== Parameters ===

==== Path Parameters ====
None.

==== Query Parameters ====
{| class="wikitable"
! Parameter !! Type !! Required !! Description
|-
| page || integer || No || Page number for pagination (default: 1). Page size is 10
|}

==== Request Body ====
{| class="wikitable"
! Parameter !! Type !! Required !! Description
|-
| call_type || integer || No || Call type filter: <code>1</code> = outgoing, <code>2</code> = incoming, <code>3</code> = missed
|-
| from_date || date || No || Start date for filtering calls (used with <code>to_date</code>)
|-
| to_date || date || No || End date for filtering calls (used with <code>from_date</code>)
|-
| 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)
|}

=== Successful Response (200) ===
Returns call logs grouped by date, with pagination metadata.

{| class="wikitable"
! 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[] ====
{| class="wikitable"
! Field !! Type !! Description
|-
| date || string || Grouped call date label (user timezone)
|-
| call_data || array || Calls for that date
|}

==== data[].call_data[] ====
{| class="wikitable"
! 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: <code>m/d/Y</code>)
|-
| call_time || string || Call time in the user’s timezone (format: <code>g:i A</code>)
|-
| 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 ===
{| class="wikitable"
! Status Code !! Meaning
|-
| 200 || Validation failed – response body uses <code>clientStatusCode</code> 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 <code>from_date</code>, <code>to_date</code>, <code>call_type</code>, or <code>search</code>.
* '''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.

← Older revision		Revision as of 06:13, 21 July 2026
Line 1:		Line 1:
−	== Get Call Log Details ==	+	== [[Mobile_API]] »Get Call Log Details ==

	=== Base URL ===		=== Base URL ===

@@ Line 49: / Line 49: @@
 | page || integer || No || Page number (can also be sent as a query parameter)
 |}
 === Successful Response (200) ===

Voice Mail - Revision history

Ashley DeBon: /* Successful Response (200) */

Ashley DeBon: /* Get Call Log Details */

Ashley DeBon: Created page with "== Get Call Log Details == === Base URL === https://apimobile.callproof.com === Endpoint === /api/call-log === Purpose === Retrieves a paginated call history for the authen..."