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
Parameters | Description | Required | Options | |
---|---|---|---|---|
Query | ||||
secretKey | string | your secret key | yes | - |
roomName | string | name of the room you want to fetch | yes | - |
Request Samples
- cURL
- NodeJs
- Ruby
- Python
- Go
cURL
curl --request GET \
--url 'https://appname.metered.live/api/v1/realtimelivestreaming/room/{roomName}?secretKey={replace_this_with_your_secretKey}' \
--header 'Accept: application/json'
NodeJs (Axios)
//We are using axios to send requests in our example
const axios = require('axios');
async function (){
try{
const response = await axios.get('https://appname.metered.live/api/v1/realtimelivestreaming/room/{roomName}',
{
params: {
secretKey: 'your_secret_key'
}
})
console.log(response)
} catch(error){
console.log(error)
}
}
Ruby
require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://yourapp.metered.live/api/v1/realtimelivestreaming/room/{roomName}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
response = http.request(request)
puts response.read_body
Python
import requests
url = "https://yourapp.metered.live/api/v1/realtimelivestreaming/room/{roomName}"
headers = {"Accept": "application/json"}
response = requests.request("GET", url, headers=headers)
print(response.text)
Go
package main
import (
"fmt"
"io/ioutil"
"log"
"net/http"
)
func main() {
client := &http.Client{}
req, err := http.NewRequest("GET", "https://appname.metered.live/api/v1/realtimelivestreaming/room/{roomName}?secretKey={replace_this_with_your_secretKey}", nil)
if err != nil {
log.Fatal(err)
}
req.Header.Set("Accept", "application/json")
resp, err := client.Do(req)
if err != nil {
log.Fatal(err)
}
defer resp.Body.Close()
bodyText, err := ioutil.ReadAll(resp.Body)
if err != nil {
log.Fatal(err)
}
fmt.Printf("%s\n", bodyText)
}
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"
}