Live Platform API v1
Live Platform API
Live
Platform API
Home
/
Live
/
Platform API

Overview

Users are able to watch a live event as participants. Participants can receive the host's media stream and send messages to the chat. This document explains how you can retrieve information on participants in a Sendbird application using the Sendbird Live Platform API.


Resource representation

The following tables show the list of properties in a participant resource.

Property nameTypeDescription

participant_id

string

The unique ID of the participant.

entered_at

long

The timestamp of when the participant entered the live event, in Unix milliseconds.

exited_at

long

The timestamp of when the participant left the live event, in Unix milliseconds.

duration

int

The period from when the participant entered the live event to when the participant left the live event, in milliseconds.

user

User

The user who can access features of a participant in the live event.

client_id

string

The unique ID of the client.

state

string

The state of the participant.

live_event_id

string

The unique ID of the live event.


Actions

  • API endpoints are relative to the base URL allocated to your application. In this page, the /live-events endpoint refers to https://api-{application_id}.calls.sendbird.com/v1.

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 {live_event_id}.

List of actions

ActionHTTP request

Retrieve participants

GET /live-events/{live_event_id}/participants
Retrieves all participants in a specific live event.