Uiza Documentation
2020-05-07
2020-05-07
  • Hola! 👋
  • Getting Started
    • Introduction
    • Authentication
    • Errors
    • Quick Starts
      • Live Streaming
      • Video Streaming
    • Pagination
    • Recommended Specifications
    • Postman Collections
    • Sample Streaming Apps
      • NodeJS Live Streaming App
      • Java Live Streaming App
      • Python Live Streaming App
      • How to integrate live streaming into an Android App using Uiza’s Live API
    • Versioning
  • API Reference
    • Live Entities
      • Create A Live Entity
      • Retrieve A Live Entity
      • Update A Live Entity
      • [Deprecated] Update A Live Entity
      • Delete A Live Entity
      • List All Live Entities
      • [Deprecated] Enable Live Entity DVR
      • [Deprecated] Disable Live Entity DVR
      • Reset Ingest Key
    • Live Sessions
      • Retrieve A Live Session
      • List All Live Sessions
    • Video Entities
      • Retrieve A Video Entity
      • Update A Video Entity
      • Publish A Video Entity
      • Delete A Video Entity
      • List All Video Entities
    • Video Presets
      • Create a Video Preset
      • Retrieve a Video Preset
      • Update a Video Preset
      • Delete a Video Preset
      • List all Video Presets
      • Add Profile(s) to Video Preset
      • Remove Profile(s) from Video Preset
    • Video Profiles
      • List All Video Profiles
    • Events
      • Retrieve An Event
      • List All Events
      • Event Types
    • Webhook Endpoints
      • Create Webhook Endpoint
      • Retrieve Webhook Endpoint
      • Update Webhook Endpoint
      • [Deprecated] Update Webhook Endpoint
      • Delete Webhook Endpoint
      • List All Webhook Endpoints
      • [Deprecated] Enable A Webhook Endpoint
      • [Deprecated] Disable A Webhook Endpoint
  • SDK REFERENCE
    • Introduction
    • Android SDK
      • Android Player SDK
      • Android Broadcast SDK
    • iOS SDK
      • iOS Player SDK
      • iOS Broadcast SDK
    • Web Player SDK
  • API UPGRADES
    • Release Notes
    • API Changelog
Powered by GitBook
On this page

Was this helpful?

  1. API Reference
  2. Live Sessions

Retrieve A Live Session

Retrieves the details of an existing live session. The live session’s id that was returned upon retrieving all live sessions is required for identifying the exact one to be retrieved.

/v1/live_entities/:entity_id/live_sessions/:id

GET https://api.uiza.sh/v1/live_entities/:entity_id/live_sessions/:id

Path Parameters

Name
Type
Description

id

string

The identifier of the live session to be retrieved.

entity_id

string

The identifier of the live entity whose live sessions are to be retrieved.

{
    "id": "26bc07f6-c581-4c77-acbe-4ed7564d2e39",
    "live_entity_id": "df0c96c0-c9ed-4d66-ba3a-cc09e36b3828",
    "video_entity_id": "f42b4ac3-869e-4010-8e21-042e40be7655",
    "ingest_key": "live_Yez8pTBcPh",
    "duration": 324.703,
    "dvr": true,
    "preset": {
        "id": "8ab03df6-1dde-4625-a3eb-ef5cf62e4e6e",
        "name": "Uiza LIVE 480p",
        "description": "Made by developer",
        "is_default": false,
        "profiles": [
            {
                "id": "735299b7-5988-11ea-883b-028fc5698662",
                "name": "480p H264 30fps Normal Latency",
                "segment_duration": 4,
                "orientation": "landscape",
                "video_profile": {
                    "video_resolution": "480",
                    "video_codec": "H264",
                    "video_bitrate": "1000K",
                    "video_frame_rate": "30"
                },
                "audio_profile": {
                    "audio_channel": "2",
                    "audio_codec": "AAC",
                    "audio_bitrate": "128K",
                    "audio_frame_rate": "1"
                }
            }
        ],
        "created_at": "2020-03-16T09:06:21Z",
        "updated_at": "2020-03-17T06:47:20Z"
    },
    "created_at": "2020-03-18T03:00:32Z",
    "updated_at": "2020-03-18T03:05:56Z"
}
{
 "message": "Your request is missing id parameter. Please, verify and resubmit.",
 "error_type": "invalid_request_error"
}
{
 "message": "Your request is missing entity_id parameter. Please, verify and resubmit.",
 "error_type": "invalid_request_error"
}
{
 "message": "You are unauthorized to access the requested resource. Please verify and resubmit.",
 "error_type": "invalid_request_error"
}
{
 "message": "The live session you requested does not exist.",
 "error_type": "invalid_request_error"
}
{
 "message": "An unexpected error occurred on Uiza's end.",
 "error_type": "api_error"
}
Sample Request
curl -X GET https://api.uiza.sh/v1/live_entities/ddb781eb-38d1-42bf-921f-0d2d9130ce15/live_sessions/1a513f1a-fe0e-4662-9512-233db26811b3 
     -H 'Authorization: uap-c1ffbff4db954ddcb050c6af0b43ba56-41193b64' 

PreviousLive SessionsNextList All Live Sessions

Last updated 5 years ago

Was this helpful?