Room creation - Revision history

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

2026-07-21T13:34:29Z

‎Successful Response (200)

Ashley DeBon: /* Create Video Message Room */

2026-07-21T13:34:03Z

‎Create Video Message Room

Ashley DeBon: Created page with "== Create Video Message Room == === Base URL === https://apimobile.callproof.com === Endpoint === /api/create-room === Purpose === Creates a one-to-one video message room b..."

2026-07-21T13:33:53Z

Created page with "== Create Video Message Room == === Base URL === https://apimobile.callproof.com === Endpoint === /api/create-room === Purpose === Creates a one-to-one video message room b..."

New page

== Create Video Message Room ==

=== Base URL ===
https://apimobile.callproof.com

=== Endpoint ===
/api/create-room

=== Purpose ===
Creates a one-to-one video message room between the authenticated user and another user. If a room already exists between those two users, the existing room ID is returned instead of creating a duplicate.

=== HTTP Method ===
POST

=== Headers ===
{| class="wikitable"
! Header !! Required !! Description
|-
| Authorization || Yes || Bearer access token
|}

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

=== Parameters ===

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

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

==== Request Body ====
{| class="wikitable"
! Parameter !! Type !! Required !! Description
|-
| toId || integer/string || Yes || Unique identifier of the other user to open a room with (must not be the authenticated user’s own ID)
|}

=== Successful Response (200) ===
Indicates that a room was created, or an existing room was found.

{| 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 || Unique room identifier
|-
| uri || string || Requested resource URI
|}

=== Error Responses ===
{| class="wikitable"
! Status Code !! Meaning
|-
| 200 || Validation / business-rule failed – response body uses <code>clientStatusCode</code> 401 with an error message
|-
| 400 || Bad Request – the room could not be created
|-
| 401 || Unauthorized – missing, invalid, or expired Bearer token
|}

* '''Validation / rule (HTTP 200, clientStatusCode 401)''' – Missing <code>toId</code>, or <code>toId</code> matches the logged-in user (for example, "Provided user matched with login users! please try some other users").
* '''400''' – Room creation failed (for example, cross-company messaging not allowed, or "Error while creating room").
* '''401''' – Authentication failed or the access token is missing/expired.

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

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

@@ Line 37: / Line 37: @@
 | toId || integer/string || Yes || Unique identifier of the other user to open a room with (must not be the authenticated user’s own ID)
 |}
 === Successful Response (200) ===