Get Videomessage

Mobile_API »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

Header	Required	Description
Authorization	Yes	Bearer access token

Security

• Yes – Requires Bearer Token authentication.

Parameters

Path Parameters

Parameter	Type	Required	Description
room	string	Yes	Room identifier used to load messages for that conversation

Query Parameters

Parameter	Type	Required	Description
page	integer	No	Page number for pagination (default: 1). Page size is 10

Request Body

None.

cURL Example for Android

 curl --location 'https://apimobile.callproof.com/api/videomessage/YOUR_ROOM_ID?page=1' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' 

cURL Example for iOS

 curl --location 'https://apimobile.callproof.com/api/videomessage/YOUR_ROOM_ID?page=1' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' 

Successful Response (200)

Returns a paginated list of video messages for the room.

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[]

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	true 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

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.