Difference between revisions of "Video Message View Status"
Ashley DeBon (talk | contribs) (→Mark Video Message As Viewed) |
Ashley DeBon (talk | contribs) (→Successful Response (200)) |
||
| Line 37: | Line 37: | ||
==== Request Body ==== | ==== Request Body ==== | ||
None. | None. | ||
| + | |||
| + | === cURL Example for Android === | ||
| + | |||
| + | <pre> curl --location --request POST 'https://apimobile.callproof.com/api/video-message-view/YOUR_MESSAGE_ID' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre> | ||
| + | |||
| + | === cURL Example for iOS === | ||
| + | |||
| + | <pre> curl --location --request POST 'https://apimobile.callproof.com/api/video-message-view/YOUR_MESSAGE_ID' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre> | ||
=== Successful Response (200) === | === Successful Response (200) === | ||
Latest revision as of 13:39, 21 July 2026
Mobile_API » Mark Video Message As Viewed
Base URL
https://apimobile.callproof.com
Endpoint
/api/video-message-view/{message_id}
Purpose
Marks a video message as viewed/read for the authenticated user. Updates the message view status from unread to read and records the read time.
HTTP Method
POST
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer access token |
Security
- Yes – Requires Bearer Token authentication.
Parameters
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| message_id | integer | Yes | Unique identifier of the video message to mark as viewed |
Query Parameters
None.
Request Body
None.
cURL Example for Android
curl --location --request POST 'https://apimobile.callproof.com/api/video-message-view/YOUR_MESSAGE_ID' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
cURL Example for iOS
curl --location --request POST 'https://apimobile.callproof.com/api/video-message-view/YOUR_MESSAGE_ID' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Successful Response (200)
Indicates that the message was marked as viewed successfully.
| 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_id | integer | Identifier of the message that was marked as viewed |
| message | string | Confirmation message (for example, "Processed successfully.") |
| uri | string | Requested resource URI |
Error Responses
| Status Code | Meaning |
|---|---|
| 400 | Bad Request – the message could not be marked as viewed |
| 401 | Unauthorized – missing, invalid, or expired Bearer token |
- 400 – Invalid message ID ("Invalid message id"), no unread view record to update for the current user, or another processing error (for example, "Error while processing").
- 401 – Authentication failed or the access token is missing/expired.