Difference between revisions of "Delete Video Message Stream"
Ashley DeBon (talk | contribs) (Created page with "== Delete Video Message Stream == === Base URL === https://apimobile.callproof.com === Endpoint === /api/delete-videomessage-stream === Purpose === Records deletion of a vi...") |
Ashley DeBon (talk | contribs) (→Successful Response (200)) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | == Delete Video Message Stream == | + | == [[Mobile_API]] »Delete Video Message Stream == |
=== Base URL === | === Base URL === | ||
| Line 37: | Line 37: | ||
| message_url_string || string || Yes || Stream identifier in the format <code>{room_id}_{user_id}_{random_string}</code> | | message_url_string || string || Yes || Stream identifier in the format <code>{room_id}_{user_id}_{random_string}</code> | ||
|} | |} | ||
| + | |||
| + | === cURL Example for Android === | ||
| + | |||
| + | <pre> curl --location 'https://apimobile.callproof.com/api/delete-videomessage-stream' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "message_url_string": "YOUR_ROOM_ID_YOUR_USER_ID_RANDOM_STRING" }' </pre> | ||
| + | |||
| + | === cURL Example for iOS === | ||
| + | |||
| + | <pre> curl --location 'https://apimobile.callproof.com/api/delete-videomessage-stream' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "message_url_string": "YOUR_ROOM_ID_YOUR_USER_ID_RANDOM_STRING" }' </pre> | ||
=== Successful Response (200) === | === Successful Response (200) === | ||
Latest revision as of 13:47, 21 July 2026
Mobile_API »Delete Video Message Stream
Base URL
https://apimobile.callproof.com
Endpoint
/api/delete-videomessage-stream
Purpose
Records deletion of a video message stream session. The request provides a stream identifier string that includes the room, user, and a random segment; the API stores that deletion record.
HTTP Method
POST
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer access token |
Security
- Yes – Requires Bearer Token authentication.
Parameters
Path Parameters
None.
Query Parameters
None.
Request Body
| Parameter | Type | Required | Description |
|---|---|---|---|
| message_url_string | string | Yes | Stream identifier in the format {room_id}_{user_id}_{random_string}
|
cURL Example for Android
curl --location 'https://apimobile.callproof.com/api/delete-videomessage-stream' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "message_url_string": "YOUR_ROOM_ID_YOUR_USER_ID_RANDOM_STRING" }'
cURL Example for iOS
curl --location 'https://apimobile.callproof.com/api/delete-videomessage-stream' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "message_url_string": "YOUR_ROOM_ID_YOUR_USER_ID_RANDOM_STRING" }'
Successful Response (200)
Indicates that the video message stream deletion was recorded successfully.
| 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 |
| message | string | Confirmation message (for example, "The video message has been deleted successfully.") |
| uri | string | Requested resource URI |
Error Responses
| Status Code | Meaning |
|---|---|
| 200 | Validation failed – response body uses clientStatusCode 401 with the first validation error message
|
| 400 | Bad Request – the stream could not be deleted |
| 401 | Unauthorized – missing, invalid, or expired Bearer token |
- Validation (HTTP 200, clientStatusCode 401) – Missing
message_url_string. - 400 – Processing failed (for example, "Error while processing" or "Error while deleting the video message").
- 401 – Authentication failed or the access token is missing/expired.
