Difference between revisions of "Video Message Seen Details"
Ashley DeBon (talk | contribs) (Created page with "== Get Video Message Seen Details == === Base URL === https://apimobile.callproof.com === Endpoint === /api/video-message-seen-details/{message_id} === Purpose === Retrieve...") |
Ashley DeBon (talk | contribs) (→Successful Response (200)) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | == Get Video Message Seen Details == | + | ==[[Mobile_API]] » Get Video Message Seen Details == |
=== Base URL === | === Base URL === | ||
| Line 37: | Line 37: | ||
==== Request Body ==== | ==== Request Body ==== | ||
None. | None. | ||
| + | |||
| + | === cURL Example for Android === | ||
| + | |||
| + | <pre> curl --location 'https://apimobile.callproof.com/api/video-message-seen-details/YOUR_MESSAGE_ID' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre> | ||
| + | |||
| + | === cURL Example for iOS === | ||
| + | |||
| + | <pre> curl --location 'https://apimobile.callproof.com/api/video-message-seen-details/YOUR_MESSAGE_ID' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre> | ||
=== Successful Response (200) === | === Successful Response (200) === | ||
Latest revision as of 13:49, 21 July 2026
Contents
Mobile_API » Get Video Message Seen Details
Base URL
https://apimobile.callproof.com
Endpoint
/api/video-message-seen-details/{message_id}
Purpose
Retrieves who has viewed a specific video message, including each viewer’s name and the time the message was read.
HTTP Method
GET
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 |
Query Parameters
None.
Request Body
None.
cURL Example for Android
curl --location 'https://apimobile.callproof.com/api/video-message-seen-details/YOUR_MESSAGE_ID' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
cURL Example for iOS
curl --location 'https://apimobile.callproof.com/api/video-message-seen-details/YOUR_MESSAGE_ID' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Successful Response (200)
Returns read/view details for the video message. If there are no view records, data may be an empty array.
| 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 | List of message view groups (see below) |
| uri | string | Requested resource URI |
data[]
| Field | Type | Description |
|---|---|---|
| members | array | Users who have viewed/read the message |
data[].members[]
| Field | Type | Description |
|---|---|---|
| user_id | integer | Unique identifier of the viewer |
| user_name | string | Full name of the viewer |
| message_read_time | string | Timestamp when the message was read (empty string when not available) |
Error Responses
| Status Code | Meaning |
|---|---|
| 400 | Bad Request – seen details could not be retrieved |
| 401 | Unauthorized – missing, invalid, or expired Bearer token |
- 400 – An error occurred while loading video message seen details.
- 401 – Authentication failed or the access token is missing/expired.
