Ashley DeBon: /* Successful Response (200) */

2026-07-21T13:35:45Z

‎Successful Response (200)

Ashley DeBon: /* Create Video Room Group */

2026-07-21T13:35:27Z

‎Create Video Room Group

Ashley DeBon: Created page with "== Create Video Room Group == === Base URL === https://apimobile.callproof.com === Endpoint === /api/create-room-group === Purpose === Creates a new video message group roo..."

2026-07-21T13:35:16Z

Created page with "== Create Video Room Group == === Base URL === https://apimobile.callproof.com === Endpoint === /api/create-room-group === Purpose === Creates a new video message group roo..."

New page

== 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 automatically added as a member if not already included. An optional group image can be uploaded (images smaller than 5KB are ignored).

=== HTTP Method ===
POST

=== Headers ===
{| class="wikitable"
! Header !! Required !! Description
|-
| Authorization || Yes || Bearer access token
|-
| Content-Type || Conditional || Use <code>multipart/form-data</code> when uploading a group image
|}

=== Security ===
* '''Yes''' – Requires Bearer Token authentication.

=== Parameters ===

==== Path Parameters ====
None.

==== Query Parameters ====
None.

==== Request Body ====
{| class="wikitable"
! 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
|-
| group_image || file || No || Optional group icon/image. Files smaller than 5KB are discarded
|}

=== Successful Response (200) ===
Indicates that the group room was created successfully.

{| class="wikitable"
! 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 group room
|-
| uri || string || Requested resource URI
|}

=== Error Responses ===
{| class="wikitable"
! Status Code !! Meaning
|-
| 200 || Validation failed – response body uses <code>clientStatusCode</code> 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 <code>group_name</code> or <code>user_ids</code>.
* '''400''' – An error occurred while creating the room (for example, "Error while creating room").
* '''401''' – Authentication failed or the access token is missing/expired.

← Older revision		Revision as of 13:35, 21 July 2026
Line 1:		Line 1:
−	== Create Video Room Group ==	+	== [[Mobile_API]] »Create Video Room Group ==

	=== Base URL ===		=== Base URL ===

@@ Line 43: / Line 43: @@
 | group_image || file || No || Optional group icon/image. Files smaller than 5KB are discarded
 |}
 === Successful Response (200) ===

Group Room creation - Revision history

Ashley DeBon: /* Successful Response (200) */

Ashley DeBon: /* Create Video Room Group */

Ashley DeBon: Created page with "== Create Video Room Group == === Base URL === https://apimobile.callproof.com === Endpoint === /api/create-room-group === Purpose === Creates a new video message group roo..."