Video Message View Status

From docs
Revision as of 13:38, 21 July 2026 by Ashley DeBon (talk | contribs) (Mark Video Message As Viewed)
Jump to: navigation, search

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.

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.