Difference between revisions of "Group Room delete"

From docs
Jump to: navigation, search
(Delete Room Group)
(Successful Response (200))
 
Line 37: Line 37:
 
==== Request Body ====
 
==== Request Body ====
 
None.
 
None.
 +
 +
=== cURL Example for Android ===
 +
 +
<pre> curl --location --request DELETE 'https://apimobile.callproof.com/api/delete-room-group/YOUR_GROUP_ID' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre>
 +
 +
=== cURL Example for iOS ===
 +
 +
<pre> curl --location --request DELETE 'https://apimobile.callproof.com/api/delete-room-group/YOUR_GROUP_ID' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre>
  
 
=== Successful Response (200) ===
 
=== Successful Response (200) ===

Latest revision as of 13:37, 21 July 2026

Mobile_API »Delete Room Group

Base URL

https://apimobile.callproof.com

Endpoint

/api/delete-room-group/{group_id}

Purpose

Deletes a video-message room group. Only a group admin can delete the group, and the ID must refer to an existing group room.

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
group_id integer Yes Unique identifier of the room group to delete

Query Parameters

None.

Request Body

None.

cURL Example for Android

 curl --location --request DELETE 'https://apimobile.callproof.com/api/delete-room-group/YOUR_GROUP_ID' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' 

cURL Example for iOS

 curl --location --request DELETE 'https://apimobile.callproof.com/api/delete-room-group/YOUR_GROUP_ID' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' 

Successful Response (200)

Indicates that the room group was deleted successfully.

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

Status Code Meaning
200 Authorization/validation failed – response body uses clientStatusCode 401 with an error message
400 Bad Request – the group could not be deleted
401 Unauthorized – missing, invalid, or expired Bearer token
  • Validation/authorization (HTTP 200, clientStatusCode 401) – Group not found ("Group id not found"), or the authenticated user is not a group admin ("Group admin only have privileges to delete this group").
  • 400 – An error occurred while deleting the group (for example, "Error while processing").
  • 401 – Authentication failed or the access token is missing/expired.