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

2026-07-21T13:25:37Z

‎Successful Response (200)

Ashley DeBon: /* Get Video Messages By Room */

2026-07-21T13:25:05Z

‎Get Video Messages By Room

Ashley DeBon: Created page with "== Get Video Messages By Room == === Base URL === https://apimobile.callproof.com === Endpoint === /api/videomessage/{room} === Purpose === Retrieves a paginated list of vi..."

2026-07-21T13:24:54Z

Created page with "== Get Video Messages By Room == === Base URL === https://apimobile.callproof.com === Endpoint === /api/videomessage/{room} === Purpose === Retrieves a paginated list of vi..."

New page

== Get Video Messages By Room ==

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

=== Endpoint ===
/api/videomessage/{room}

=== Purpose ===
Retrieves a paginated list of video messages for a specific room/conversation. Messages are returned newest first and include unread status for the authenticated user, creator details, and media links.

=== HTTP Method ===
GET

=== Headers ===
{| class="wikitable"
! Header !! Required !! Description
|-
| Authorization || Yes || Bearer access token
|}

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

=== Parameters ===

==== Path Parameters ====
{| class="wikitable"
! Parameter !! Type !! Required !! Description
|-
| room || string || Yes || Room identifier used to load messages for that conversation
|}

==== Query Parameters ====
{| class="wikitable"
! Parameter !! Type !! Required !! Description
|-
| page || integer || No || Page number for pagination (default: 1). Page size is 10
|}

==== Request Body ====
None.

=== Successful Response (200) ===
Returns a paginated list of video messages for the room.

{| 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
|-
| data || array || List of video messages (see below)
|-
| firstItemOnPage || integer || Index of the first item on the current page
|-
| lastItemOnPage || integer || Index of the last item on the current page
|-
| hasNextPage || boolean || Whether a next page is available
|-
| hasPreviousPage || boolean || Whether a previous page is available
|-
| isFirstPage || boolean || Whether the current page is the first page
|-
| isLastPage || boolean || Whether the current page is the last page
|-
| next_page_url || string/null || URL of the next page, when available
|-
| prev_page_url || string/null || URL of the previous page, when available
|-
| first_page_url || string || URL of the first page
|-
| last_page_url || string || URL of the last page
|-
| pageCount || integer || Total number of pages
|-
| pageNumber || integer || Current page number
|-
| pageSize || integer || Number of items per page (10)
|-
| totalItemCount || integer || Total number of messages in the room
|-
| uri || string || Requested resource URI
|}

==== data[] ====
{| class="wikitable"
! Field !! Type !! Description
|-
| message_id || integer || Unique identifier of the video message
|-
| is_unread || boolean || Whether the message is unread for the authenticated user
|-
| delete_access || boolean || <code>true</code> if the authenticated user created the message and can delete it
|-
| gif || string || Base64-encoded GIF URL when available; otherwise empty string
|-
| create_by || integer || User ID of the message creator
|-
| name || string || Full name of the message creator
|-
| created || string/datetime || Message created timestamp
|-
| updated || string/datetime || Message updated timestamp
|-
| replay_url || string || Playback URL for the video message
|}

=== Error Responses ===
{| class="wikitable"
! Status Code !! Meaning
|-
| 400 || Bad Request – video messages could not be retrieved
|-
| 401 || Unauthorized – missing, invalid, or expired Bearer token
|}

* '''400''' – Room not found, or another retrieval error (for example, "Error while retrieving the twilio conversation details").
* '''401''' – Authentication failed or the access token is missing/expired.

← Older revision		Revision as of 13:25, 21 July 2026
Line 1:		Line 1:
−	== Get Video Messages By Room ==	+	== [[Mobile_API]] »Get Video Messages By Room ==

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

@@ Line 41: / Line 41: @@
 ==== Request Body ====
 None.
 === Successful Response (200) ===

Get Videomessage - Revision history

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

Ashley DeBon: /* Get Video Messages By Room */

Ashley DeBon: Created page with "== Get Video Messages By Room == === Base URL === https://apimobile.callproof.com === Endpoint === /api/videomessage/{room} === Purpose === Retrieves a paginated list of vi..."