Skip to main content

GET : API to Get a Livestreaming Room


GET
    https://<appname>.metered.live/api/v1/realtimelivestreaming/room/{roomName}

<appname> - replace it the name of your app.

<roomName> - The name of the room that you want to Get.

Description

This endpoint allows you to GET a Live streaming Room

Parameters

ParametersDescriptionRequiredOptions
Query
secretKeystringyour secret keyyes-
roomNamestringname of the room you want to fetchyes-

Request Samples

cURL
curl --request GET \
--url 'https://appname.metered.live/api/v1/realtimelivestreaming/room/{roomName}?secretKey={replace_this_with_your_secretKey}' \
--header 'Accept: application/json'

Responses

200
 {
"viewerURL": "https://livestreamingdemo.metered.live/62b5e390cb82524b9cee9816/player",
"broadcastManager": "https://dashboard.metered.ca/livestreaming-rooms/62b5e390cb82524b9cee9816/app/62b5d44bd00c04354f16af71/broadcast",
"roomName": "pepvxawbes",
"currentlyBroadcasting": false,
"displayMessage": "Live stream will begin shortly",
"created": "2022-06-24T16:17:20.976Z",
"_id": "62b5e390cb82524b9cee9816"
}
400

{
"success": false,
"message": "Invalid request"
}