Video Message Callback

Mobile_API » Video Message Callback

Base URL

https://apimobile.callproof.com

Endpoint

/api/videomessage-callback

Purpose

Webhook callback used by the video messaging provider (Zego) after a stream/recording completes. The API stores the callback payload, creates the related video message for the room, optionally generates a GIF preview, and sends email/push notifications to room members.

HTTP Method

POST

Headers

Header	Required	Description
Content-Type	Recommended	Typically application/x-www-form-urlencoded (provider callback)

Security

• No – Public callback endpoint (not under Bearer Token middleware).

Parameters

Path Parameters

None.

Query Parameters

None.

Request Body

Provider callback fields consumed by the API:

Parameter	Type	Required	Description
stream_alias	string	Yes	Stream alias in the form {room_id}_{created_user_id}_...; used to resolve room and creator
appid	string/integer	Yes	Provider application ID
begin_time	string/integer	No*	Stream/recording begin time
end_time	string/integer	No*	Stream/recording end time
nonce	string	No*	Provider nonce
replay_url	string	No*	Playback/replay URL for the recorded video
signature	string	No*	Provider signature
stream_id	string	No*	Provider stream ID
timestamp	string/integer	No*	Provider timestamp
extra_params	string (JSON)	No*	JSON object that includes Duration (used for duration/GIF generation)

\*These fields are read and stored when present as part of a successful callback payload.

cURL Example for Android

 curl --location 'https://apimobile.callproof.com/api/videomessage-callback' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'stream_alias=YOUR_ROOM_ID_YOUR_USER_ID_RANDOM_STRING' \ --data-urlencode 'appid=YOUR_APP_ID' \ --data-urlencode 'begin_time=' \ --data-urlencode 'end_time=' \ --data-urlencode 'nonce=' \ --data-urlencode 'replay_url=' \ --data-urlencode 'signature=' \ --data-urlencode 'stream_id=' \ --data-urlencode 'timestamp=' \ --data-urlencode 'extra_params={}' 

cURL Example for iOS

 curl --location 'https://apimobile.callproof.com/api/videomessage-callback' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'stream_alias=YOUR_ROOM_ID_YOUR_USER_ID_RANDOM_STRING' \ --data-urlencode 'appid=YOUR_APP_ID' \ --data-urlencode 'begin_time=' \ --data-urlencode 'end_time=' \ --data-urlencode 'nonce=' \ --data-urlencode 'replay_url=' \ --data-urlencode 'signature=' \ --data-urlencode 'stream_id=' \ --data-urlencode 'timestamp=' \ --data-urlencode 'extra_params={}' 

Successful Response (200)

Indicates that the callback was accepted/stored successfully.

Field	Type	Description
clientStatusCode	integer	Status indicator for the client (for example, 200)
message	string	Confirmation message (for example, "Callback response stored successfully.")
uri	string	Requested resource URI

Error Responses

Status Code	Meaning
400	Bad Request – callback could not be processed/stored

• 400 – Missing/invalid callback data, invalid stream_alias room/user IDs, or another processing error (for example, "Error while storing video message response").