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

Retrieve a live event

Retrieves a specified live event. Only an ongoing live event can be retrieved.


HTTP request

GET https://api-{application_id}.calls.sendbird.com/v1/live-events/{live_event_id}

Response

If successful, this action returns a live event in the response body.

{
    "live_event": {
        "live_event_id": "60fce3f2-840a-49d2-99e9-4de7206010b5",
        "host_type": "single_host",
        "state": "ready",
        "created_at": 1657689627823,
        "set_ready_at": 1657689627867,
        "started_at": none,
        "ended_at": none,
        "is_host_streaming": false,
        "host": none,
        "created_by": "testuser-00be487",
        "set_ready_by": "testuser-00be487",
        "started_by": "",
        "ended_by": "",
        "duration": 0,
        "participant_count": 5,
        "peak_participant_count": 7,
        "cumulative_participant_count": 21,
        "user_ids_for_host": ["testuser-00be487"],
        "custom_items": {},
    }
}

List of response properties

Property nameTypeDescription

live_event

nested object

The live event that has been retrieved.