room participant joined

curl --request GET \
  --url https://apix.us.amity.co/realtime/room.participantJoined

{
  "data": {
    "rooms": [
      {
        "_id": "690c6a641b055f909ff1c8e1",
        "roomId": "690c6a641b055f909ff1c8e1",
        "path": "606f37a0ae601e3c33eba9e3/room/690c6a641b055f909ff1c8e1",
        "title": "e4920036-3dd4-4fc3-958c-072d520ba716",
        "liveChatEnabled": false,
        "childRoomIds": [],
        "participants": [
          {
            "userId": "teste2c39fe5-d5fc-4943-a9be-cf54ad4d0825",
            "type": "host"
          },
          {
            "userId": "testuser123-456-789",
            "type": "participant"
          }
        ],
        "createdBy": "teste2c39fe5-d5fc-4943-a9be-cf54ad4d0825",
        "type": "directStreaming",
        "status": "live",
        "liveAt": "2025-11-06T09:52:35.917Z",
        "isDeleted": false,
        "createdAt": "2025-11-06T09:29:08.260Z",
        "updatedAt": "2025-11-06T09:56:00.000Z",
        "creatorInternalId": "690c6a0bfb181288c0325726",
        "livePlaybackUrl": "https://stream.mux.com/bD02uiCium1GTisHi4V2ifIPA1ZrGlzZKDck2IC2Drnc.m3u8?token=eyJhbGci...",
        "liveThumbnailUrl": "https://image.mux.com/bD02uiCium1GTisHi4V2ifIPA1ZrGlzZKDck2IC2Drnc/thumbnail.png?token=eyJhbGci...",
        "recordedPlaybackInfos": []
      }
    ],
    "users": [
      {
        "_id": "690c6a0bfb181288c0325726",
        "path": "606f37a0ae601e3c33eba9e3/user/690c6a0bfb181288c0325726",
        "displayName": "Stamm - O'Reilly",
        "userId": "teste2c39fe5-d5fc-4943-a9be-cf54ad4d0825"
      },
      {
        "_id": "690c6a0bfb181288c0325727",
        "path": "606f37a0ae601e3c33eba9e3/user/690c6a0bfb181288c0325727",
        "displayName": "New Participant",
        "userId": "testuser123-456-789"
      }
    ],
    "files": []
  },
  "eventType": "room.participantJoined",
  "id": "testuser123-456-789",
  "networkId": "606f37a0ae601e3c33eba9e3",
  "path": "606f37a0ae601e3c33eba9e3/room/690c6a641b055f909ff1c8e1",
  "senderId": "asc-app-c1-588c759896-pmzz8-1",
  "sentTime": "2025-11-06T09:56:00.123Z",
  "version": 1
}

GET

realtime

room.participantJoined

room participant joined

curl --request GET \
  --url https://apix.us.amity.co/realtime/room.participantJoined

{
  "data": {
    "rooms": [
      {
        "_id": "690c6a641b055f909ff1c8e1",
        "roomId": "690c6a641b055f909ff1c8e1",
        "path": "606f37a0ae601e3c33eba9e3/room/690c6a641b055f909ff1c8e1",
        "title": "e4920036-3dd4-4fc3-958c-072d520ba716",
        "liveChatEnabled": false,
        "childRoomIds": [],
        "participants": [
          {
            "userId": "teste2c39fe5-d5fc-4943-a9be-cf54ad4d0825",
            "type": "host"
          },
          {
            "userId": "testuser123-456-789",
            "type": "participant"
          }
        ],
        "createdBy": "teste2c39fe5-d5fc-4943-a9be-cf54ad4d0825",
        "type": "directStreaming",
        "status": "live",
        "liveAt": "2025-11-06T09:52:35.917Z",
        "isDeleted": false,
        "createdAt": "2025-11-06T09:29:08.260Z",
        "updatedAt": "2025-11-06T09:56:00.000Z",
        "creatorInternalId": "690c6a0bfb181288c0325726",
        "livePlaybackUrl": "https://stream.mux.com/bD02uiCium1GTisHi4V2ifIPA1ZrGlzZKDck2IC2Drnc.m3u8?token=eyJhbGci...",
        "liveThumbnailUrl": "https://image.mux.com/bD02uiCium1GTisHi4V2ifIPA1ZrGlzZKDck2IC2Drnc/thumbnail.png?token=eyJhbGci...",
        "recordedPlaybackInfos": []
      }
    ],
    "users": [
      {
        "_id": "690c6a0bfb181288c0325726",
        "path": "606f37a0ae601e3c33eba9e3/user/690c6a0bfb181288c0325726",
        "displayName": "Stamm - O'Reilly",
        "userId": "teste2c39fe5-d5fc-4943-a9be-cf54ad4d0825"
      },
      {
        "_id": "690c6a0bfb181288c0325727",
        "path": "606f37a0ae601e3c33eba9e3/user/690c6a0bfb181288c0325727",
        "displayName": "New Participant",
        "userId": "testuser123-456-789"
      }
    ],
    "files": []
  },
  "eventType": "room.participantJoined",
  "id": "testuser123-456-789",
  "networkId": "606f37a0ae601e3c33eba9e3",
  "path": "606f37a0ae601e3c33eba9e3/room/690c6a641b055f909ff1c8e1",
  "senderId": "asc-app-c1-588c759896-pmzz8-1",
  "sentTime": "2025-11-06T09:56:00.123Z",
  "version": 1
}

Response

200 - application/json

RTE data for room.participantJoined event

string

The participant user ID

Example:

"testuser123-456-789"

data

object

Show child attributes

data.rooms

object[]

Array containing the room

Show child attributes

data.rooms._id

string

Internal room ID

data.rooms.type

enum<string>

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

Available options:

directStreaming,

coHosts

data.rooms.targetId

string

ID of the target of the entity that room belongs to

data.rooms.targetType

enum<string>

Target of the entity that room belongs to

Available options:

community,

user

data.rooms.referenceType

enum<string>

Entity that room is associated with

Available options:

post

data.rooms.referenceId

string

Entity ID that room is associated with

data.rooms.liveChannelId

string

Associated live channel ID for chat

data.rooms.liveChatEnabled

boolean

Whether live channel is enabled

data.rooms.title

string

Room title

data.rooms.roomId

string

Public room ID

data.rooms.description

string

Room description

data.rooms.thumbnailFileId

string

Thumbnail file ID

data.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

data.rooms.participants

object[]

List of room streaming participants

Show child attributes

data.rooms.participants.type

enum<string>

Available options:

coHost,

host

data.rooms.participants.userId

string

data.rooms.livePlaybackUrl

string

Live playback URL

Example:

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

data.rooms.liveThumbnailUrl

string

Live thumbnail URL

Example:

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

data.rooms.recordedPlaybackInfos

object[]

Recorded playback URLs and thumbnails

Show child attributes

data.rooms.recordedPlaybackInfos.url

string

Recorded playback URL

Example:

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

data.rooms.recordedPlaybackInfos.thumbnailUrl

string

Recorded thumbnail URL

Example:

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

data.rooms.durationSeconds

number

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

data.rooms.moderation

object

Moderation information including flagged and terminated labels

Show child attributes

data.rooms.moderation.flagLabels

object[]

Labels that triggered flag actions

Show child attributes

data.rooms.moderation.flagLabels.category

string

Moderation category

data.rooms.moderation.flagLabels.threshold

number

Threshold value that triggered the flag

data.rooms.moderation.flagLabels.detectedAt

string<date-time>

When the flag was detected

data.rooms.moderation.terminateLabels

object[]

Labels that triggered terminate actions

Show child attributes

data.rooms.moderation.terminateLabels.category

string

Moderation category

data.rooms.moderation.terminateLabels.threshold

number

Threshold value that triggered termination

data.rooms.moderation.terminateLabels.detectedAt

string<date-time>

When the termination was detected

data.rooms.moderation.updatedAt

string<date-time>

Last moderation update timestamp

data.rooms.parentRoomId

string

Parent room ID for child streams

data.rooms.childRoomIds

string[]

Child room IDs

data.rooms.createdAt

string<date-time>

Creation timestamp

data.rooms.createdBy

string

Room creator user public ID

data.rooms.creatorInternalId

string

Room creator user internal ID

Example:

"64be1f6cb9b4106b5a6bbf3f"

data.rooms.updatedAt

string<date-time>

Last update timestamp

data.rooms.liveAt

string<date-time>

When broadcasting started

data.rooms.endedAt

string<date-time>

When broadcasting ended

data.rooms.recordedAt

string<date-time>

When recording became available

data.rooms.isDeleted

boolean

Whether room is deleted

data.rooms.deletedAt

string<date-time>

Deletion timestamp

data.rooms.deletedBy

string

User who deleted the room

data.rooms.path

string

Room path for realtime events

data.rooms.metadata

object

Custom metadata

data.users

object[]

Array of users involved in the room

Show child attributes

data.users.userId

string

required

data.users.createdAt

string<date-time>

required

data.users.updatedAt

string<date-time>

required

data.users._id

string

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

data.users.path

string

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

data.users.userInternalId

string

data.users.userPublicId

string

data.users.roles

string[]

data.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

data.users.displayName

string

data.users.profileHandle

string

data.users.description

string

data.users.avatarFileId

string

data.users.avatarCustomUrl

string

data.users.flagCount

integer

data.users.hashFlag

object

Show child attributes

data.users.hashFlag.bits

integer

data.users.hashFlag.hashes

integer

data.users.hashFlag.hash

string[]

data.users.metadata

object

data.users.isGlobalBan

boolean

Global ban status. Every user can see this flag.

data.users.isBrand

boolean

Brand user status.

data.users.isDeleted

boolean

data.files

object[]

Array of files associated with the room (may be empty)

Show child attributes

data.files.fileId

string

Root file key on cloud storage.

data.files.fileUrl

string

Http link for download file

data.files.type

enum<string>

File type.

Available options:

image,

file,

video

data.files.accessType

enum<string>

default:public

File access type. network type requires authentication to download.

Available options:

public,

network

data.files.altText

string

Alternative text for the file.

Maximum string length: 180

data.files.createdAt

string<date-time>

The date/time when a file is uploaded.

data.files.updatedAt

string<date-time>

The date/time when a file is updated.

data.files.attributes

object

Show child attributes

data.files.attributes.name

string

File name.

data.files.attributes.extension

string

File format.

data.files.attributes.size

number

File size.

data.files.attributes.mimeType

string

File mime-type.

data.files.attributes.metadata

object

File image metadata (width, height etc.).

Show child attributes

data.files.attributes.metadata.exif

object

data.files.attributes.metadata.gps

object

data.files.attributes.metadata.height

number

data.files.attributes.metadata.width

number

data.files.attributes.metadata.isFull

boolean

networkId

string

ID of the network.

path

string

A topic path for subscription.

eventType

string

Name of the event.

senderId

string

ID of sender node.

sendTime

string<date-time>

The date/time when event was sent.

version

string

Version of API

room was terminated room participant left

⌘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

room participant joined

Response