Difference between revisions of "Get what's New"
Ashley DeBon (talk | contribs) (Created page with "== Get Latest Release Notes == === Base URL === https://apimobile.callproof.com === Endpoint === /api/releases === Purpose === Retrieves CallProof Plus app release/“What...") |
Ashley DeBon (talk | contribs) (→Successful Response (200)) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | == Get Latest Release Notes == | + | == [[Mobile_API]] »Get Latest Release Notes == |
=== Base URL === | === Base URL === | ||
| Line 43: | Line 43: | ||
==== Request Body ==== | ==== Request Body ==== | ||
None. | None. | ||
| + | |||
| + | === cURL Example for Android === | ||
| + | |||
| + | <pre> curl --location 'https://apimobile.callproof.com/api/releases?os-type=android&version-number=YOUR_APP_VERSION' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'os-type: android' \ --header 'version-number: YOUR_APP_VERSION' </pre> | ||
| + | |||
| + | === cURL Example for iOS === | ||
| + | |||
| + | <pre> curl --location 'https://apimobile.callproof.com/api/releases?os-type=ios&version-number=6.3' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'os-type: ios' \ --header 'version-number: 6.3' </pre> | ||
=== Successful Response (200) === | === Successful Response (200) === | ||
Latest revision as of 12:52, 20 July 2026
Mobile_API »Get Latest Release Notes
Base URL
https://apimobile.callproof.com
Endpoint
/api/releases
Purpose
Retrieves CallProof Plus app release/“What’s New” notes. Results are filtered to Plus app builds (not call-log builds), ordered newest first. Release details may vary based on OS type and app version (iOS clients on version 6.3+ can receive iOS-specific details).
HTTP Method
GET
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer access token |
| os-type | No | Client OS (for example, ios). Can also be sent as a query/body parameter
|
| version-number | No | Client app version (for example, 6.3). Can also be sent as version_number or as a query/body parameter
|
Security
- Yes – Requires Bearer Token authentication.
Parameters
Path Parameters
None.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| os-type / os_type | string | No | Client OS type (same effect as the os-type header)
|
| version-number / version_number | string | No | Client app version (same effect as the version-number header)
|
Request Body
None.
cURL Example for Android
curl --location 'https://apimobile.callproof.com/api/releases?os-type=android&version-number=YOUR_APP_VERSION' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'os-type: android' \ --header 'version-number: YOUR_APP_VERSION'
cURL Example for iOS
curl --location 'https://apimobile.callproof.com/api/releases?os-type=ios&version-number=6.3' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'os-type: ios' \ --header 'version-number: 6.3'
Successful Response (200)
Returns the list of release notes.
| 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 | Release notes list |
| uri | string | Requested resource URI |
data[]
| Field | Type | Description |
|---|---|---|
| id | integer | Unique identifier of the release record |
| name | string | Release/build name |
| apk | string | APK / build reference |
| is_call_log | boolean | Whether this is a call-log build (filtered to false for this endpoint)
|
| details | string | Release notes text shown to the client (may use iOS-specific text for iOS 6.3+) |
| created | string/datetime | Record created timestamp |
| is_plus_app | boolean | Whether this is a Plus app release (filtered to true for this endpoint)
|
| version | string | Release version number |
| release_date | string | Release date formatted as m/d/Y, or empty string when not set
|
Error Responses
| Status Code | Meaning |
|---|---|
| 400 | Bad Request – release notes could not be retrieved |
| 401 | Unauthorized – missing, invalid, or expired Bearer token |
- 400 – An error occurred while loading release notes.
- 401 – Authentication failed or the access token is missing/expired.
