Videomessage Pushnotification - Revision history

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

2026-07-21T13:16:44Z

‎Successful Response (200)

Ashley DeBon: /* Video Message Push Notification */

2026-07-21T13:16:11Z

‎Video Message Push Notification

Ashley DeBon: Created page with "== Video Message Push Notification == === Base URL === https://apimobile.callproof.com === Endpoint === /api/videomessage-pushnotification === Purpose === Intended to send..."

2026-07-21T13:15:59Z

Created page with "== Video Message Push Notification == === Base URL === https://apimobile.callproof.com === Endpoint === /api/videomessage-pushnotification === Purpose === Intended to send..."

New page

== Video Message Push Notification ==

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

=== Endpoint ===
/api/videomessage-pushnotification

=== Purpose ===
Intended to send a push notification for a video message to a recipient in a video room.

'''Note:''' In the current codebase, the push-notification call is commented out and replaced with an empty result, so this endpoint always returns a failure response. Notifications are described in code comments as being sent later from a callback after the file URL is received.

=== HTTP Method ===
POST

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

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

=== Parameters ===

==== Path Parameters ====
None.

==== Query Parameters ====
None.

==== Request Body ====
{| class="wikitable"
! Parameter !! Type !! Required !! Description
|-
| room_id || string || Yes (intended) || Video room identifier for the notification payload
|-
| to_id || string || Yes (intended) || Recipient user identifier
|}

No request validation is currently enforced in the active controller code.

=== Successful Response (200) ===
Would indicate the notification was processed successfully (when push sending is enabled).

{| class="wikitable"
! Field !! Type !! Description
|-
| clientStatusCode || integer || Status indicator for the client (for example, 200)
|-
| message || string || Confirmation message (for example, "Processed successfully.")
|-
| uri || string || Requested resource URI
|}

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

* '''400''' – Current implementation always returns this path (for example, "Error while processing"), because push sending is disabled in the controller.
* '''401''' – Authentication failed or the access token is missing/expired.

← Older revision		Revision as of 13:16, 21 July 2026
Line 43:		Line 43:

	No request validation is currently enforced in the active controller code.		No request validation is currently enforced in the active controller code.
		+
		+	=== cURL Example for Android ===
		+
		+	<pre> curl --location 'https://apimobile.callproof.com/api/videomessage-pushnotification' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "room_id": "YOUR_ROOM_ID", "to_id": "YOUR_RECIPIENT_USER_ID" }' </pre>
		+
		+	=== cURL Example for iOS ===
		+
		+	<pre> curl --location 'https://apimobile.callproof.com/api/videomessage-pushnotification' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "room_id": "YOUR_ROOM_ID", "to_id": "YOUR_RECIPIENT_USER_ID" }' </pre>

	=== Successful Response (200) ===		=== Successful Response (200) ===

← Older revision		Revision as of 13:16, 21 July 2026
Line 1:		Line 1:
−	== Video Message Push Notification ==	+	== [[Mobile_API]] »Video Message Push Notification ==

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