CreateRoom - TCN API

Room

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

type

enum<string>

type

optional

Allowed values:

ROOM_TYPE_DIRECTROOM_TYPE_MULTIROOM_TYPE_SYSTEMROOM_TYPE_GLOBAL_SYSTEM

permission_group_id

string

permission_group_id

optional

Optional id of the permission group assigned to this room.

name

string

name

optional

members

array[string]

members

optional

Example

{
  "type": "ROOM_TYPE_DIRECT",
  "permission_group_id": "string",
  "name": "string",
  "members": [
    "string"
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

type

enum<string>

type

optional

type - DIRECT, MULTI, SYSTEM

Allowed values:

ROOM_TYPE_DIRECTROOM_TYPE_MULTIROOM_TYPE_SYSTEMROOM_TYPE_GLOBAL_SYSTEM

created_at

string <date-time>

created_at

optional

unix timestamp for time created

updated_at

string <date-time>

updated_at

optional

unix timestamp for time updated

status

enum<string>

status

optional

status of the room

Allowed values:

ROOM_STATUS_ACTIVEROOM_STATUS_ARCHIVEDROOM_STATUS_DELETED

config

object (RoomConfig)

config

optional

room configuration details

add_user

enum<string>

add_user

optional

ConfigPermissionEnum -

Allowed values:

LIMITEDROOM303_MEMBERROOM303_SUPERVISOR

remove_user

enum<string>

remove_user

optional

ConfigPermissionEnum -

Allowed values:

LIMITEDROOM303_MEMBERROOM303_SUPERVISOR

promote_to_admin

enum<string>

promote_to_admin

optional

ConfigPermissionEnum -

Allowed values:

LIMITEDROOM303_MEMBERROOM303_SUPERVISOR

read_messages

enum<string>

read_messages

optional

ConfigPermissionEnum -

Allowed values:

LIMITEDROOM303_MEMBERROOM303_SUPERVISOR

send_message

enum<string>

send_message

optional

ConfigPermissionEnum -

Allowed values:

LIMITEDROOM303_MEMBERROOM303_SUPERVISOR

archive_room

enum<string>

archive_room

optional

ConfigPermissionEnum -

Allowed values:

LIMITEDROOM303_MEMBERROOM303_SUPERVISOR

permission_group_id

string

permission_group_id

optional

Optional id of the permission group assigned to this room.

org_id

string

org_id

optional

organization id

room_id

string

room_id

optional

TODO: WIP deprecate - unique room id

string

optional

Id's value will be a hash when room_type is DIRECT or the room name when MULTI.
Used in ui for routing when room type is not available.
Will replace room_id once it's fully deprecated

display_name

string

display_name

optional

display name for the room which is replacing the field "name".

Example

{
  "type": "ROOM_TYPE_DIRECT",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "status": "ROOM_STATUS_ACTIVE",
  "config": {
    "add_user": "LIMITED",
    "remove_user": "LIMITED",
    "promote_to_admin": "LIMITED",
    "read_messages": "LIMITED",
    "send_message": "LIMITED",
    "archive_room": "LIMITED"
  },
  "permission_group_id": "string",
  "org_id": "string",
  "room_id": "string",
  "id": "string",
  "display_name": "string"
}

🔴500Server Error