Difference between revisions of "Video Message Delete"
Ashley DeBon (talk | contribs) (Created page with "== Delete Video Message == === Base URL === https://apimobile.callproof.com === Endpoint === /api/video-message-delete/{message_id} === Purpose === Deletes a video message...") |
Ashley DeBon (talk | contribs) (→Successful Response (200)) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | == Delete Video Message == | + | == [[Mobile_API]] »Delete Video Message == |
=== Base URL === | === Base URL === | ||
| Line 37: | Line 37: | ||
==== Request Body ==== | ==== Request Body ==== | ||
None. | None. | ||
| + | |||
| + | === cURL Example for Android === | ||
| + | |||
| + | <pre> curl --location --request DELETE 'https://apimobile.callproof.com/api/video-message-delete/YOUR_MESSAGE_ID' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre> | ||
| + | |||
| + | === cURL Example for iOS === | ||
| + | |||
| + | <pre> curl --location --request DELETE 'https://apimobile.callproof.com/api/video-message-delete/YOUR_MESSAGE_ID' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre> | ||
=== Successful Response (200) === | === Successful Response (200) === | ||
Latest revision as of 13:40, 21 July 2026
Contents
Mobile_API »Delete Video Message
Base URL
https://apimobile.callproof.com
Endpoint
/api/video-message-delete/{message_id}
Purpose
Deletes a video message created by the authenticated user. Only the message creator can delete it.
HTTP Method
DELETE
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer access token |
Security
- Yes – Requires Bearer Token authentication.
Parameters
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| message_id | integer | Yes | Unique identifier of the video message to delete |
Query Parameters
None.
Request Body
None.
cURL Example for Android
curl --location --request DELETE 'https://apimobile.callproof.com/api/video-message-delete/YOUR_MESSAGE_ID' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
cURL Example for iOS
curl --location --request DELETE 'https://apimobile.callproof.com/api/video-message-delete/YOUR_MESSAGE_ID' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Successful Response (200)
Indicates that the video message was deleted successfully.
| Field | Type | Description |
|---|---|---|
| clientStatusCode | integer | Status indicator for the client (for example, 200) |
| message | string | Confirmation message (for example, "Videomessage deleted successfully") |
| uri | string | Requested resource URI |
Error Responses
| Status Code | Meaning |
|---|---|
| 200 | Authorization/ownership check failed – response body uses clientStatusCode 401 (for example, invalid message ID or message not owned by the user)
|
| 400 | Bad Request – the video message could not be deleted |
| 401 | Unauthorized – missing, invalid, or expired Bearer token |
- Ownership check (HTTP 200, clientStatusCode 401) – Message not found for the authenticated user, or invalid message ID ("Invalid message id").
- 400 – An error occurred while deleting the message (for example, "Error while processing").
- 401 – Authentication failed or the access token is missing/expired.
