Skip to main content

Messages

Messages are ephemeral in nature. They persist only during transmission and are not stored on the server. Recipients must be active participants in the meeting at the time messages are sent in order to receive them.

Broadcast Message​

Broadcast data messages to all users of a meeting.

POST /rooms/`ACCESS_KEY`/messages
RESPONSE 201 CREATED, 400 BAD REQUEST, 404 NOT FOUND, 410 GONE
REQUIRED type, content
Example Req/Res: Broadcast Message
Request
curl -X POST -H "Content-Type: application/json" \
-d "{"type": "chat", "content": "I will appear as a broadcast message."}" \ "https://api.eyeson.team/rooms/$ACCESS_KEY/messages"
Response
201

type​

Type: STRING (required)
Manages the visibility of messages in the Prebuilt-UI chat.

ValueDescription
chatMessages are shown in the chat of the Prebuilt-UI
customMessages do not show up in the Prebuilt-UI
info

Both types will show up in the Meeting Observer and as broadcasts in the client logs.

content​

Type: STRING (required)
Data content.