create room

curl --request POST \
  --url https://apix.us.amity.co/api/v1/rooms \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "thumbnailFileId": "<string>",
  "metadata": {},
  "liveChatEnabled": true,
  "parentRoomId": "<string>",
  "type": "directStreaming"
}
'

{
  "rooms": [
    {
      "_id": "<string>",
      "type": "directStreaming",
      "targetId": "<string>",
      "targetType": "community",
      "referenceType": "post",
      "referenceId": "<string>",
      "liveChannelId": "<string>",
      "liveChatEnabled": true,
      "title": "<string>",
      "roomId": "<string>",
      "description": "<string>",
      "thumbnailFileId": "<string>",
      "status": "idle",
      "participants": [
        {
          "type": "coHost",
          "userId": "<string>"
        }
      ],
      "livePlaybackUrl": "https://stream.example.com/someid.m3u8?token=token",
      "liveThumbnailUrl": "https://image.example.com/someid/thumbnail.png?token=token",
      "recordedPlaybackInfos": [
        {
          "url": "https://apix.eu.amity.co/api/v1/rooms/roomid/recorded/someid/watch",
          "thumbnailUrl": "https://apix.eu.amity.co/api/v1/rooms/roomid/recorded/someid/thumbnail"
        }
      ],
      "durationSeconds": 123,
      "moderation": {
        "flagLabels": [
          {
            "category": "<string>",
            "threshold": 123,
            "detectedAt": "2023-11-07T05:31:56Z"
          }
        ],
        "terminateLabels": [
          {
            "category": "<string>",
            "threshold": 123,
            "detectedAt": "2023-11-07T05:31:56Z"
          }
        ],
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "parentRoomId": "<string>",
      "childRoomIds": [],
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "creatorInternalId": "64be1f6cb9b4106b5a6bbf3f",
      "updatedAt": "2023-11-07T05:31:56Z",
      "liveAt": "2023-11-07T05:31:56Z",
      "endedAt": "2023-11-07T05:31:56Z",
      "recordedAt": "2023-11-07T05:31:56Z",
      "isDeleted": true,
      "deletedAt": "2023-11-07T05:31:56Z",
      "deletedBy": "<string>",
      "path": "<string>",
      "metadata": {}
    }
  ],
  "roomChildrens": [
    {
      "_id": "<string>",
      "type": "directStreaming",
      "targetId": "<string>",
      "targetType": "community",
      "referenceType": "post",
      "referenceId": "<string>",
      "liveChannelId": "<string>",
      "liveChatEnabled": true,
      "title": "<string>",
      "roomId": "<string>",
      "description": "<string>",
      "thumbnailFileId": "<string>",
      "status": "idle",
      "participants": [
        {
          "type": "coHost",
          "userId": "<string>"
        }
      ],
      "livePlaybackUrl": "https://stream.example.com/someid.m3u8?token=token",
      "liveThumbnailUrl": "https://image.example.com/someid/thumbnail.png?token=token",
      "recordedPlaybackInfos": [
        {
          "url": "https://apix.eu.amity.co/api/v1/rooms/roomid/recorded/someid/watch",
          "thumbnailUrl": "https://apix.eu.amity.co/api/v1/rooms/roomid/recorded/someid/thumbnail"
        }
      ],
      "durationSeconds": 123,
      "moderation": {
        "flagLabels": [
          {
            "category": "<string>",
            "threshold": 123,
            "detectedAt": "2023-11-07T05:31:56Z"
          }
        ],
        "terminateLabels": [
          {
            "category": "<string>",
            "threshold": 123,
            "detectedAt": "2023-11-07T05:31:56Z"
          }
        ],
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "parentRoomId": "<string>",
      "childRoomIds": [],
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "creatorInternalId": "64be1f6cb9b4106b5a6bbf3f",
      "updatedAt": "2023-11-07T05:31:56Z",
      "liveAt": "2023-11-07T05:31:56Z",
      "endedAt": "2023-11-07T05:31:56Z",
      "recordedAt": "2023-11-07T05:31:56Z",
      "isDeleted": true,
      "deletedAt": "2023-11-07T05:31:56Z",
      "deletedBy": "<string>",
      "path": "<string>",
      "metadata": {}
    }
  ],
  "users": [
    {
      "userId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "_id": "<string>",
      "path": "<string>",
      "userInternalId": "<string>",
      "userPublicId": "<string>",
      "roles": [
        "<string>"
      ],
      "permissions": [
        "MUTE_CHANNEL"
      ],
      "displayName": "<string>",
      "profileHandle": "<string>",
      "description": "<string>",
      "avatarFileId": "<string>",
      "avatarCustomUrl": "<string>",
      "flagCount": 123,
      "hashFlag": {
        "bits": 123,
        "hashes": 123,
        "hash": [
          "<string>"
        ]
      },
      "metadata": {},
      "isGlobalBan": true,
      "isBrand": true,
      "isDeleted": true
    }
  ],
  "files": [
    {
      "fileId": "<string>",
      "fileUrl": "<string>",
      "type": "image",
      "accessType": "public",
      "altText": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "attributes": {
        "name": "<string>",
        "extension": "<string>",
        "size": 123,
        "mimeType": "<string>",
        "metadata": {
          "exif": {},
          "gps": {},
          "height": 123,
          "width": 123,
          "isFull": true
        }
      }
    }
  ]
}

POST

api

rooms

create room

curl --request POST \
  --url https://apix.us.amity.co/api/v1/rooms \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "thumbnailFileId": "<string>",
  "metadata": {},
  "liveChatEnabled": true,
  "parentRoomId": "<string>",
  "type": "directStreaming"
}
'

{
  "rooms": [
    {
      "_id": "<string>",
      "type": "directStreaming",
      "targetId": "<string>",
      "targetType": "community",
      "referenceType": "post",
      "referenceId": "<string>",
      "liveChannelId": "<string>",
      "liveChatEnabled": true,
      "title": "<string>",
      "roomId": "<string>",
      "description": "<string>",
      "thumbnailFileId": "<string>",
      "status": "idle",
      "participants": [
        {
          "type": "coHost",
          "userId": "<string>"
        }
      ],
      "livePlaybackUrl": "https://stream.example.com/someid.m3u8?token=token",
      "liveThumbnailUrl": "https://image.example.com/someid/thumbnail.png?token=token",
      "recordedPlaybackInfos": [
        {
          "url": "https://apix.eu.amity.co/api/v1/rooms/roomid/recorded/someid/watch",
          "thumbnailUrl": "https://apix.eu.amity.co/api/v1/rooms/roomid/recorded/someid/thumbnail"
        }
      ],
      "durationSeconds": 123,
      "moderation": {
        "flagLabels": [
          {
            "category": "<string>",
            "threshold": 123,
            "detectedAt": "2023-11-07T05:31:56Z"
          }
        ],
        "terminateLabels": [
          {
            "category": "<string>",
            "threshold": 123,
            "detectedAt": "2023-11-07T05:31:56Z"
          }
        ],
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "parentRoomId": "<string>",
      "childRoomIds": [],
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "creatorInternalId": "64be1f6cb9b4106b5a6bbf3f",
      "updatedAt": "2023-11-07T05:31:56Z",
      "liveAt": "2023-11-07T05:31:56Z",
      "endedAt": "2023-11-07T05:31:56Z",
      "recordedAt": "2023-11-07T05:31:56Z",
      "isDeleted": true,
      "deletedAt": "2023-11-07T05:31:56Z",
      "deletedBy": "<string>",
      "path": "<string>",
      "metadata": {}
    }
  ],
  "roomChildrens": [
    {
      "_id": "<string>",
      "type": "directStreaming",
      "targetId": "<string>",
      "targetType": "community",
      "referenceType": "post",
      "referenceId": "<string>",
      "liveChannelId": "<string>",
      "liveChatEnabled": true,
      "title": "<string>",
      "roomId": "<string>",
      "description": "<string>",
      "thumbnailFileId": "<string>",
      "status": "idle",
      "participants": [
        {
          "type": "coHost",
          "userId": "<string>"
        }
      ],
      "livePlaybackUrl": "https://stream.example.com/someid.m3u8?token=token",
      "liveThumbnailUrl": "https://image.example.com/someid/thumbnail.png?token=token",
      "recordedPlaybackInfos": [
        {
          "url": "https://apix.eu.amity.co/api/v1/rooms/roomid/recorded/someid/watch",
          "thumbnailUrl": "https://apix.eu.amity.co/api/v1/rooms/roomid/recorded/someid/thumbnail"
        }
      ],
      "durationSeconds": 123,
      "moderation": {
        "flagLabels": [
          {
            "category": "<string>",
            "threshold": 123,
            "detectedAt": "2023-11-07T05:31:56Z"
          }
        ],
        "terminateLabels": [
          {
            "category": "<string>",
            "threshold": 123,
            "detectedAt": "2023-11-07T05:31:56Z"
          }
        ],
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "parentRoomId": "<string>",
      "childRoomIds": [],
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "creatorInternalId": "64be1f6cb9b4106b5a6bbf3f",
      "updatedAt": "2023-11-07T05:31:56Z",
      "liveAt": "2023-11-07T05:31:56Z",
      "endedAt": "2023-11-07T05:31:56Z",
      "recordedAt": "2023-11-07T05:31:56Z",
      "isDeleted": true,
      "deletedAt": "2023-11-07T05:31:56Z",
      "deletedBy": "<string>",
      "path": "<string>",
      "metadata": {}
    }
  ],
  "users": [
    {
      "userId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "_id": "<string>",
      "path": "<string>",
      "userInternalId": "<string>",
      "userPublicId": "<string>",
      "roles": [
        "<string>"
      ],
      "permissions": [
        "MUTE_CHANNEL"
      ],
      "displayName": "<string>",
      "profileHandle": "<string>",
      "description": "<string>",
      "avatarFileId": "<string>",
      "avatarCustomUrl": "<string>",
      "flagCount": 123,
      "hashFlag": {
        "bits": 123,
        "hashes": 123,
        "hash": [
          "<string>"
        ]
      },
      "metadata": {},
      "isGlobalBan": true,
      "isBrand": true,
      "isDeleted": true
    }
  ],
  "files": [
    {
      "fileId": "<string>",
      "fileUrl": "<string>",
      "type": "image",
      "accessType": "public",
      "altText": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "attributes": {
        "name": "<string>",
        "extension": "<string>",
        "size": 123,
        "mimeType": "<string>",
        "metadata": {
          "exif": {},
          "gps": {},
          "height": 123,
          "width": 123,
          "isFull": true
        }
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Information of room to be created

title

string

required

Room title

Maximum string length: 1000

description

string

Room description

Maximum string length: 5000

thumbnailFileId

string

Thumbnail file ID

Maximum string length: 50

metadata

object

Custom metadata

liveChatEnabled

boolean

default:true

Indicates whether the live channel (chat) is enabled for the room

parentRoomId

string

Optional parent room ID for creating child streams

Maximum string length: 50

type

enum<string>

default:directStreaming

Type of room: directStreaming for single participant streaming, coHosts for multiple participants

Available options:

directStreaming,

coHosts

Response

list of rooms

rooms

object[]

Show child attributes

rooms._id

string

Internal room ID

rooms.type

enum<string>

Type of room * directStreaming - single participant streaming * coHosts - More than one participant

Available options:

directStreaming,

coHosts

rooms.targetId

string

ID of the target of the entity that room belongs to

rooms.targetType

enum<string>

Target of the entity that room belongs to

Available options:

community,

user

rooms.referenceType

enum<string>

Entity that room is associated with

Available options:

post

rooms.referenceId

string

Entity ID that room is associated with

rooms.liveChannelId

string

Associated live channel ID for chat

rooms.liveChatEnabled

boolean

Whether live channel is enabled

rooms.title

string

Room title

rooms.roomId

string

Public room ID

rooms.description

string

Room description

rooms.thumbnailFileId

string

Thumbnail file ID

rooms.status

enum<string>

Status of room * idle - room is just created * live - broadcasting is active * waitingReconnect - broadcaster disconnected, waiting for reconnection * ended - broadcasting stopped * recorded - room recordings available

Available options:

idle,

live,

waitingReconnect,

ended,

recorded

rooms.participants

object[]

List of room streaming participants

Show child attributes

rooms.participants.type

enum<string>

Available options:

coHost,

host

rooms.participants.userId

string

rooms.livePlaybackUrl

string

Live playback URL

Example:

"https://stream.example.com/someid.m3u8?token=token"

rooms.liveThumbnailUrl

string

Live thumbnail URL

Example:

"https://image.example.com/someid/thumbnail.png?token=token"

rooms.recordedPlaybackInfos

object[]

Recorded playback URLs and thumbnails

Show child attributes

rooms.recordedPlaybackInfos.url

string

Recorded playback URL

Example:

"https://apix.eu.amity.co/api/v1/rooms/roomid/recorded/someid/watch"

rooms.recordedPlaybackInfos.thumbnailUrl

string

Recorded thumbnail URL

Example:

"https://apix.eu.amity.co/api/v1/rooms/roomid/recorded/someid/thumbnail"

rooms.durationSeconds

number

Duration of the broadcast in seconds (only for ended/recorded rooms)

rooms.moderation

object

Moderation information including flagged and terminated labels

Show child attributes

rooms.moderation.flagLabels

object[]

Labels that triggered flag actions

Show child attributes

rooms.moderation.flagLabels.category

string

Moderation category

rooms.moderation.flagLabels.threshold

number

Threshold value that triggered the flag

rooms.moderation.flagLabels.detectedAt

string<date-time>

When the flag was detected

rooms.moderation.terminateLabels

object[]

Labels that triggered terminate actions

Show child attributes

rooms.moderation.terminateLabels.category

string

Moderation category

rooms.moderation.terminateLabels.threshold

number

Threshold value that triggered termination

rooms.moderation.terminateLabels.detectedAt

string<date-time>

When the termination was detected

rooms.moderation.updatedAt

string<date-time>

Last moderation update timestamp

rooms.parentRoomId

string

Parent room ID for child streams

rooms.childRoomIds

string[]

Child room IDs

rooms.createdAt

string<date-time>

Creation timestamp

rooms.createdBy

string

Room creator user public ID

rooms.creatorInternalId

string

Room creator user internal ID

Example:

"64be1f6cb9b4106b5a6bbf3f"

rooms.updatedAt

string<date-time>

Last update timestamp

rooms.liveAt

string<date-time>

When broadcasting started

rooms.endedAt

string<date-time>

When broadcasting ended

rooms.recordedAt

string<date-time>

When recording became available

rooms.isDeleted

boolean

Whether room is deleted

rooms.deletedAt

string<date-time>

Deletion timestamp

rooms.deletedBy

string

User who deleted the room

rooms.path

string

Room path for realtime events

rooms.metadata

object

Custom metadata

roomChildrens

object[]

Show child attributes

roomChildrens._id

string

Internal room ID

roomChildrens.type

enum<string>

Type of room * directStreaming - single participant streaming * coHosts - More than one participant

Available options:

directStreaming,

coHosts

roomChildrens.targetId

string

ID of the target of the entity that room belongs to

roomChildrens.targetType

enum<string>

Target of the entity that room belongs to

Available options:

community,

user

roomChildrens.referenceType

enum<string>

Entity that room is associated with

Available options:

post

roomChildrens.referenceId

string

Entity ID that room is associated with

roomChildrens.liveChannelId

string

Associated live channel ID for chat

roomChildrens.liveChatEnabled

boolean

Whether live channel is enabled

roomChildrens.title

string

Room title

roomChildrens.roomId

string

Public room ID

roomChildrens.description

string

Room description

roomChildrens.thumbnailFileId

string

Thumbnail file ID

roomChildrens.status

enum<string>

Available options:

idle,

live,

waitingReconnect,

ended,

recorded

roomChildrens.participants

object[]

List of room streaming participants

Show child attributes

roomChildrens.participants.type

enum<string>

Available options:

coHost,

host

roomChildrens.participants.userId

string

roomChildrens.livePlaybackUrl

string

Live playback URL

Example:

"https://stream.example.com/someid.m3u8?token=token"

roomChildrens.liveThumbnailUrl

string

Live thumbnail URL

Example:

"https://image.example.com/someid/thumbnail.png?token=token"

roomChildrens.recordedPlaybackInfos

object[]

Recorded playback URLs and thumbnails

Show child attributes

roomChildrens.recordedPlaybackInfos.url

string

Recorded playback URL

Example:

"https://apix.eu.amity.co/api/v1/rooms/roomid/recorded/someid/watch"

roomChildrens.recordedPlaybackInfos.thumbnailUrl

string

Recorded thumbnail URL

Example:

"https://apix.eu.amity.co/api/v1/rooms/roomid/recorded/someid/thumbnail"

roomChildrens.durationSeconds

number

Duration of the broadcast in seconds (only for ended/recorded rooms)

roomChildrens.moderation

object

Moderation information including flagged and terminated labels

Show child attributes

roomChildrens.moderation.flagLabels

object[]

Labels that triggered flag actions

Show child attributes

roomChildrens.moderation.flagLabels.category

string

Moderation category

roomChildrens.moderation.flagLabels.threshold

number

Threshold value that triggered the flag

roomChildrens.moderation.flagLabels.detectedAt

string<date-time>

When the flag was detected

roomChildrens.moderation.terminateLabels

object[]

Labels that triggered terminate actions

Show child attributes

roomChildrens.moderation.terminateLabels.category

string

Moderation category

roomChildrens.moderation.terminateLabels.threshold

number

Threshold value that triggered termination

roomChildrens.moderation.terminateLabels.detectedAt

string<date-time>

When the termination was detected

roomChildrens.moderation.updatedAt

string<date-time>

Last moderation update timestamp

roomChildrens.parentRoomId

string

Parent room ID for child streams

roomChildrens.childRoomIds

string[]

Child room IDs

roomChildrens.createdAt

string<date-time>

Creation timestamp

roomChildrens.createdBy

string

Room creator user public ID

roomChildrens.creatorInternalId

string

Room creator user internal ID

Example:

"64be1f6cb9b4106b5a6bbf3f"

roomChildrens.updatedAt

string<date-time>

Last update timestamp

roomChildrens.liveAt

string<date-time>

When broadcasting started

roomChildrens.endedAt

string<date-time>

When broadcasting ended

roomChildrens.recordedAt

string<date-time>

When recording became available

roomChildrens.isDeleted

boolean

Whether room is deleted

roomChildrens.deletedAt

string<date-time>

Deletion timestamp

roomChildrens.deletedBy

string

User who deleted the room

roomChildrens.path

string

Room path for realtime events

roomChildrens.metadata

object

Custom metadata

users

object[]

Show child attributes

users.userId

string

required

users.createdAt

string<date-time>

required

users.updatedAt

string<date-time>

required

users._id

string

Private ID of a user. (for real-time event)

users.path

string

Path of a user. (for real-time event)

users.userInternalId

string

users.userPublicId

string

users.roles

string[]

users.permissions

enum<string>[]

Available options:

MUTE_CHANNEL,

CLOSE_CHANNEL,

EDIT_CHANNEL,

EDIT_CHANNEL_RATELIMIT,

EDIT_MESSAGE,

DELETE_MESSAGE,

BAN_USER_FROM_CHANNEL,

MUTE_USER_INSIDE_CHANNEL,

ADD_CHANNEL_USER,

REMOVE_CHANNEL_USER,

EDIT_CHANNEL_USER,

ASSIGN_CHANNEL_USER_ROLE,

BAN_USER,

EDIT_USER,

ASSIGN_USER_ROLE,

EDIT_USER_FEED_POST,

DELETE_USER_FEED_POST,

EDIT_USER_FEED_COMMENT,

DELETE_USER_FEED_COMMENT,

ADD_COMMUNITY_USER,

REMOVE_COMMUNITY_USER,

EDIT_COMMUNITY_USER,

BAN_COMMUNITY_USER,

MUTE_COMMUNITY_USER,

EDIT_COMMUNITY,

DELETE_COMMUNITY,

EDIT_COMMUNITY_POST,

DELETE_COMMUNITY_POST,

PIN_COMMUNITY_POST,

EDIT_COMMUNITY_COMMENT,

DELETE_COMMUNITY_COMMENT,

ASSIGN_COMMUNITY_USER_ROLE,

CREATE_COMMUNITY_CATEGORY,

EDIT_COMMUNITY_CATEGORY,

DELETE_COMMUNITY_CATEGORY,

CREATE_ROLE,

EDIT_ROLE,

DELETE_ROLE,

MANAGE_COMMUNITY_STORY

users.displayName

string

users.profileHandle

string

users.description

string

users.avatarFileId

string

users.avatarCustomUrl

string

users.flagCount

integer

users.hashFlag

object

Show child attributes

users.hashFlag.bits

integer

users.hashFlag.hashes

integer

users.hashFlag.hash

string[]

users.metadata

object

users.isGlobalBan

boolean

Global ban status. Every user can see this flag.

users.isBrand

boolean

Brand user status.

users.isDeleted

boolean

files

object[]

Show child attributes

files.fileId

string

Root file key on cloud storage.

files.fileUrl

string

Http link for download file

files.type

enum<string>

File type.

Available options:

image,

file,

video

files.accessType

enum<string>

default:public

File access type. network type requires authentication to download.

Available options:

public,

network

files.altText

string

Alternative text for the file.

Maximum string length: 180

files.createdAt

string<date-time>

The date/time when a file is uploaded.

files.updatedAt

string<date-time>

The date/time when a file is updated.

files.attributes

object

Show child attributes

files.attributes.name

string

File name.

files.attributes.extension

string

File format.

files.attributes.size

number

File size.

files.attributes.mimeType

string

File mime-type.

files.attributes.metadata

object

File image metadata (width, height etc.).

Show child attributes

files.attributes.metadata.exif

object

files.attributes.metadata.gps

object

files.attributes.metadata.height

number

files.attributes.metadata.width

number

files.attributes.metadata.isFull

boolean

get list of rooms get single room

⌘I

social.plus APIs & Services

Ads

Archive

Analytic

Authentication

Channel

Comment

Community

Community category

Event

Content

Invitation

Feed

File

Follow

Global Featured Post

Marker

Moderation

User

Message Feed

Message

Network Setting

Notification

Notification Tray

Pin post

Post

Poll

Presence

Reaction

Room

Role

Semantic Search

Session

Story

Video streaming

Webhook event

Realtime event

Authorizations

Body

Response