GroupRoomcreation

Mobile_API »Create Video Room Group

Base URL

https://apimobile.callproof.com

Endpoint

/api/create-room-group

Purpose

Creates a new video message group room for the authenticated user. The current user is always included as a member. An optional group image can be uploaded as the group icon.

HTTP Method

POST

Headers

Header	Required	Description
Authorization	Yes	Bearer access token
Content-Type	Conditional	Use multipart/form-data when uploading a group image

Security

• Yes – Requires Bearer Token authentication.

Parameters

Path Parameters

None.

Query Parameters

None.

Request Body

Parameter	Type	Required	Description
group_name	string	Yes	Name of the group room
user_ids	string	Yes	Comma-separated list of user IDs to add as group members (for example, 12,34,56). The authenticated user is added automatically if missing
group_image	file	No	Optional group icon image. Images smaller than 5 KB are ignored

cURL Example for Android

 curl --location 'https://apimobile.callproof.com/api/create-room-group' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --form 'group_name="YOUR_GROUP_NAME"' \ --form 'user_ids="12,34,56"' \ --form 'group_image=@"/path/to/your/group-image.jpg"' 

cURL Example for iOS

 curl --location 'https://apimobile.callproof.com/api/create-room-group' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --form 'group_name="YOUR_GROUP_NAME"' \ --form 'user_ids="12,34,56"' \ --form 'group_image=@"/path/to/your/group-image.jpg"' 

Successful Response (200)

Indicates that the group room was created 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, "Room created successfully")
room_id	string	Generated room identifier used by the video messaging system
group_name	string	Name of the created group
group_id	integer	Unique database identifier of the created group room
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 group room could not be created
401	Unauthorized – missing, invalid, or expired Bearer token

• Validation (HTTP 200, clientStatusCode 401) – Missing group_name or user_ids.
• 400 – An error occurred while creating the room (for example, "Error while creating room").
• 401 – Authentication failed or the access token is missing/expired.