Skip to Content
DocumentationAPI ReferenceЖиви потоци

Живи потоци API

Живите потоци API предоставят точки за откриване и извличане информация за живите си събития. Това позволява да се създаде “живи дневници” и да се вградят живи играчи в приложенията ви.


Получаване на активните живи потоци

Този е основният endpoint за откриване на потоци, които са текущо “във възход”. Той връща списък само от потоките, които активно получават сигнал от кодер.

GET /live-streams/active

Параметри

Този endpoint не приема никакви параметри. Той ще върне всички активни потоци за вашата сметка.

Примерно изискване

GET /api/client/v1/live-streams/active Host: https://your-app.com Authorization: Bearer sk-your-api-key-here

Отговор: GET /live-streams/active

Ако потоците са активни, ще получите масив от обекти LiveStream. Статусът ще бъде active и ще има обект manifest.

Отговор: 200 OK (Потокове активни)
{ "data": [ { "id": "9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f", "title": "Седмичен Q&A Сесия", "description": "Отговор на въпросите ви живо.", "status": "active", "manifest": { "hls_url": "https://your-app.com/storage/live_media/live/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f/adaptive/master.m3u8" }, "metadata": { "категория": "Технически разговори", "хост": "Джейн Дой" }, "tags": ["жив", "q&a"], "created_at": "2024-08-01T10:00:00Z" } ] }

Ако няма потоци, които са текущо активни, API ще върне празен масив от данни.

Отговор: 200 OK (Няма активни потоци)
{ "data": [] }

Получаване на всички живи потоци

Този endpoint предоставя пагинираният каталог с всички живи потоци, конфигурирани в вашата сметка, независимо от текущия им статус (активен или неактивен). Това е полезно за създаване на график или пълен списък на достъпните канали.

GET /live-streams

Параметри

ИмеТипОбязателенОписание
per_pageцелочисленоВариabileБрой потоци, които да се връщат на страница. Default: 15, Max: 100.

Примерно изискване

GET /api/client/v1/live-streams?per_page=2

Отговор: GET /live-streams

Отговора е стандартен пагинирания списък. Статусът ще бъде активен или неактивен, и обекта manifest ще се появи само за активните потоци.

Отговор: 200 OK
{ "data": [ { "id": "9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f", "title": "Седмичен Q&A Сесия", "description": "Отговор на въпросите ви живо.", "status": "активен", "manifest": { "hls_url": "https://your-app.com/storage/live_media/live/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f/adaptive/master.m3u8" }, "metadata": { "категория": "Технически разговори" }, "tags": ["жив", "q&a"], "created_at": "2024-08-01T10:00:00Z" }, { "id": "9c1a9e3e-1a2b-3c4d-5e6f-7g8h9i0j1k2l", "title": "Следващата продукция за лансиране", "description": "Придете с нас за големия разкриване.", "status": "неактивен", "metadata": { "категория": "Продукт" }, "tags": ["ланс", "събитие"], "created_at": "2024-07-25T15:00:00Z" } ], "links": { "първи": "https://your-app.com/api/client/v1/live-streams?page=1", "последен": "https://your-app.com/api/client/v1/live-streams?page=3", "предишен": null, "следващ": "https://your-app.com/api/client/v1/live-streams?page=2" }, "meta": { "текуща страница": 1, "от": 1, "последна страница": 3, "път": "https://your-app.com/api/client/v1/live-streams", "брой на страницата": 2, "до": 2, "общо": 6 } }

Получаване на единствения жив поток

Извлича пълните данни за един конкретен жив поток по неговия ID. Това е endpoint, който ще викате да получите необходимата информация за зареждане на потока в играч.

GET /live-streams/{streamId}

Патентни параметри

ИмеТипОписание
streamIduuidОбязателен. Уникалния идентификатор на живия поток.

Примерно изискване

GET /api/client/v1/live-streams/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f

Отговор: GET /live-streams/{streamId}

Отговора е единствения обект LiveStream. Обекта manifest ще се появи, ако потокът е активен.

Отговор: 200 OK (Потокът е активен)
{ "data": { "id": "9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f", "title": "Седмичен Q&A Сесия", "description": "Отговор на въпросите ви живо.", "status": "активен", "manifest": { "hls_url": "https://your-app.com/storage/live_media/live/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f/adaptive/master.m3u8" }, "metadata": { "категория": "Технически разговори", "хост": "Джейн Дой" }, "tags": ["жив", "q&a"], "created_at": "2024-08-01T10:00:00Z" } }