End Call Details - Revision history

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

2026-07-21T05:47:12Z

‎Successful Response (200)

Ashley DeBon: /* Update End Call Details */

2026-07-21T05:42:46Z

‎Update End Call Details

Ashley DeBon: Created page with "== Update End Call Details == === Base URL === https://apimobile.callproof.com === Endpoint === /api/end-call-details === Purpose === Updates details after a voice call end..."

2026-07-21T05:42:30Z

Created page with "== Update End Call Details == === Base URL === https://apimobile.callproof.com === Endpoint === /api/end-call-details === Purpose === Updates details after a voice call end..."

New page

== Update End Call Details ==

=== Base URL ===
https://apimobile.callproof.com

=== Endpoint ===
/api/end-call-details

=== Purpose ===
Updates details after a voice call ends for a contact. Saves optional call notes on the latest related call record, sets the hang-up user on that call, and updates the contact’s contact type. An optional phone number can be used to target the correct contact phone / call record.

=== 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 ====
None.

==== Request Body ====
{| class="wikitable"
! Parameter !! Type !! Required !! Description
|-
| contact_id || string || Yes || Unique identifier of the contact associated with the call
|-
| contact_type_id || string || Yes || Contact type identifier to set on the contact
|-
| notes || string || No || Notes to save on the latest matching call record
|-
| phone_number || string || No || Phone number used to locate the contact phone / call record; if omitted, the API attempts to resolve it from existing call data
|}

=== Successful Response (200) ===
Indicates that the end-call details were updated successfully.

{| 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
|-
| message || string || Confirmation message (for example, "End call details updated successfully")
|-
| uri || string || Requested resource URI
|}

=== 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 – end-call details could not be updated
|-
| 401 || Unauthorized – missing, invalid, or expired Bearer token
|}

* '''Validation (HTTP 200, clientStatusCode 401)''' – Missing <code>contact_id</code> or <code>contact_type_id</code>, or invalid <code>notes</code> type.
* '''400''' – Contact not found ("Contact Not Found"), or another update error (for example, "Error while updating end call details").
* '''401''' – Authentication failed or the access token is missing/expired.

← Older revision		Revision as of 05:42, 21 July 2026
Line 1:		Line 1:
−	== Update End Call Details ==	+	== [[Mobile_API]] »Update End Call Details ==

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

@@ Line 43: / Line 43: @@
 | phone_number || string || No || Phone number used to locate the contact phone / call record; if omitted, the API attempts to resolve it from existing call data
 |}
 === Successful Response (200) ===