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

2026-07-21T12:45:18Z

‎Successful Response (200)

Ashley DeBon: /* Store Device Logs */

2026-07-21T12:44:47Z

‎Store Device Logs

Ashley DeBon: Created page with "== Store Device Logs == === Base URL === https://apimobile.callproof.com === Endpoint === /api/logs === Purpose === Uploads a device log ZIP file for the authenticated user..."

2026-07-21T12:44:34Z

Created page with "== Store Device Logs == === Base URL === https://apimobile.callproof.com === Endpoint === /api/logs === Purpose === Uploads a device log ZIP file for the authenticated user..."

New page

== Store Device Logs ==

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

=== Endpoint ===
/api/logs

=== Purpose ===
Uploads a device log ZIP file for the authenticated user to cloud storage, records the log metadata, and notifies CallProof support by email. If the log type is Automatic, device logging is turned off for the user after upload.

=== HTTP Method ===
POST

=== Headers ===
{| class="wikitable"
! Header !! Required !! Description
|-
| Authorization || Yes || Bearer access token
|-
| Content-Type || Yes || <code>multipart/form-data</code> (file upload)
|-
| Version-Number || No || App version header; when <code>>= 5.070</code>, <code>subject</code> and <code>message</code> are included in the notification email
|}

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

=== Parameters ===

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

==== Query Parameters ====
None.

==== Request Body ====
{| class="wikitable"
! Parameter !! Type !! Required !! Description
|-
| file || file || Yes || Log archive file (must be a <code>.zip</code>)
|-
| log_type || string || No || Log type (for example, <code>Automatic</code>). Defaults to <code>None</code> when omitted
|-
| os_type || string || No || Device OS type. Defaults to <code>None</code> when omitted
|-
| version || string || No || App version. Defaults to <code>None</code> when omitted
|-
| subject || string || No || Email subject text (used when app Version-Number is <code>>= 5.070</code>)
|-
| message || string || No || Email message text (used when app Version-Number is <code>>= 5.070</code>)
|}

=== Successful Response (200) ===
Indicates that the log file was uploaded and recorded 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, "Your device logs have now been sent to CallProof.")
|-
| 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 – the log file could not be stored
|-
| 401 || Unauthorized – missing, invalid, or expired Bearer token
|}

* '''Validation (HTTP 200, clientStatusCode 401)''' – Missing <code>file</code>, or the file is not a valid ZIP.
* '''400''' – An error occurred while storing the log file or sending the notification.
* '''401''' – Authentication failed or the access token is missing/expired.

← Older revision		Revision as of 12:44, 21 July 2026
Line 1:		Line 1:
−	== Store Device Logs ==	+	==[[Mobile_API]] » Store Device Logs ==

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

@@ Line 51: / Line 51: @@
 | message || string || No || Email message text (used when app Version-Number is <code>>= 5.070</code>)
 |}
 === Successful Response (200) ===

Logs Store Process - Revision history

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

Ashley DeBon: /* Store Device Logs */

Ashley DeBon: Created page with "== Store Device Logs == === Base URL === https://apimobile.callproof.com === Endpoint === /api/logs === Purpose === Uploads a device log ZIP file for the authenticated user..."