A host is able to run a live event where participants can watch the host's media stream and interact with each other using the chat. This document explains how you can retrieve information on the host in a Sendbird application using Live Platform API.
The following tables show the list of properties in a host resource.
A unique ID of the host.
The timestamp of when the host entered the live event, in Unix milliseconds.
The timestamp of when the host was connected and media streaming of the host started, in Unix milliseconds.
The timestamp of when the host was disconnected and media streaming of the host stopped, in Unix milliseconds.
The timestamp of when the host exited the live event, in Unix milliseconds.
The period from when the host entered the live event to when the host left the live event, in milliseconds.
The user who can access features of a host in the live event.
The unique ID of the client.
The state of the host. Valid values are the following:
Indicates whether the host has turned on their audio.
Indicates whether the host has turned on their video.
The unique ID of the live event.
- API endpoints are relative to the base URL allocated to your application. In this page, the
/live-eventsendpoint refers to
Note: To get your application ID, sign in to your dashboard, go to the Settings > Application > General, and then check the Application ID.
- It's recommended that the parameter values in API URLs be URL encoded, such as
List of actions