Перейти к содержимому
Продукты

API каналов

Канал — это адрес потока, который открывают зрители. У канала есть один или несколько вариантов, например с разным битрейтом. Каждый вариант получает данные от ресивера.

Идентификаторы в API:

  • ID канала: путь в URL плейлиста, например news. Используйте буквы, цифры, -, _ и /.
  • ID варианта: ID канала и имя варианта, например news/main.

Запросы создания, изменения и удаления работают с каналом целиком. Запросы запуска и остановки работают с одним вариантом.

{
"id": "news",
"name": "News",
"enable": true,
"storage": "archive",
"duration": 48,
"authorizer": "token-auth",
"tvg_id": 101,
"tvg_logo": "https://example.com/news.png",
"variants": {
"main": { "enable": true, "receiver": "news-source" },
"low": { "enable": true, "receiver": "news-low-source" }
}
}
  • id: ID канала.
  • name: название канала. Обязательное поле.
  • enable: запускает или останавливает все варианты канала.
  • storage (необязательный): ID хранилища для архива.
  • duration (необязательный): длительность архива этого канала в часах. Переопределяет длительность хранилища.
  • authorizer (необязательный): ID авторизатора, который защищает канал.
  • tvg_id, tvg_logo (необязательные): идентификатор EPG и логотип для плейлиста M3U.
  • variants: объект с вариантами по имени. Нужен минимум один вариант.
    • enable: включает вариант.
    • receiver: ID ресивера. Обязательное поле.
    • old_name: только для PUT. См. Изменение канала.
Окно терминала
POST /api/ott/channel

Пример:

Окно терминала
curl -sS -X POST -H "Authorization: Bearer $TOKEN" \
-H 'Content-Type: application/json' \
'http://alta.example.com:8100/api/ott/channel' \
-d '{
"id": "news",
"name": "News",
"enable": true,
"storage": "archive",
"variants": {
"main": { "enable": true, "receiver": "news-source" }
}
}'
КодОписание
204Канал создан
400У варианта нет ресивера, либо включённый вариант не удаётся запустить. Причина указана в теле ответа
409Канал уже существует, либо один ресивер используется более чем одним вариантом
422Нет названия или нет вариантов
Окно терминала
PUT /api/ott/channel?id=<channel_id>

Передайте объект канала целиком. id в теле должен совпадать с id в параметре запроса.

Alta сопоставляет варианты в запросе с имеющимися вариантами по полю old_name:

  • Существующий вариант: укажите в old_name его текущее имя. Без old_name Alta считает вариант новым и удаляет существующий вариант с тем же именем.
  • Новый вариант: не указывайте old_name.
  • Переименованный вариант: укажите в old_name прежнее имя, а новое имя задайте в ключе.
  • Вариант, который нужно удалить: не включайте его в запрос.

Пример: оставить main, переименовать low в sd и добавить hd:

Окно терминала
curl -sS -X PUT -H "Authorization: Bearer $TOKEN" \
-H 'Content-Type: application/json' \
'http://alta.example.com:8100/api/ott/channel?id=news' \
-d '{
"id": "news",
"name": "News",
"enable": true,
"variants": {
"main": { "enable": true, "receiver": "news-source", "old_name": "main" },
"sd": { "enable": true, "receiver": "news-low-source", "old_name": "low" },
"hd": { "enable": true, "receiver": "news-hd-source" }
}
}'

Если значение enable канала отличается от текущего состояния, Alta применяет его ко всем вариантам. Чтобы выключить один вариант, оставьте enable канала как есть и измените enable варианта. Чтобы запустить или остановить один вариант без полного обновления, используйте Запуск и остановку.

Смена storage канала удаляет архив, записанный в прежнем хранилище.

КодОписание
204Канал изменён
400Вариант не удаётся запустить. Причина указана в теле ответа
404Вариант из old_name не существует
409Один ресивер используется более чем одним вариантом
422Нет вариантов
Окно терминала
DELETE /api/ott/channel?id=<channel_id>

Alta останавливает и удаляет все варианты канала.

Возвращает 204 или 404, если канал не существует.

Окно терминала
POST /api/ott/channel/start?id=<channel_id>/<variant>
POST /api/ott/channel/stop?id=<channel_id>/<variant>

Пример:

Окно терминала
curl -sS -X POST -H "Authorization: Bearer $TOKEN" \
'http://alta.example.com:8100/api/ott/channel/stop?id=news/main'

Запросы меняют значение enable варианта и сохраняют его, поэтому состояние сохраняется после перезапуска Alta. Повторный запрос не является ошибкой.

КодОписание
204Выполнено
400Вариант не удаётся запустить. Причина указана в теле ответа
404Вариант не существует
Окно терминала
GET /api/ott/channel/storage?id=<channel_id>/<variant>

Возвращает архив варианта в виде непрерывных блоков. Разрыв в записи начинает новый блок. Доступно ролям admin и observer.

Ответ:

[
{ "start_time": 1747485787, "size": 1572864000, "duration": 3600 }
]
  • start_time: начало блока в Unix-времени.
  • size: размер блока в байтах.
  • duration: длительность блока в секундах.

Возвращает 204, если у канала нет хранилища, и 404, если вариант не существует. Чтобы получить MP4-превью из архива, читайте Preview API.

Окно терминала
PUT /api/ott/channel/exportm3u

Строит плейлист M3U из переданного списка. Для каналов с хранилищем Alta добавляет параметры архива, а для каналов с tvg_id или tvg_logo — параметры EPG. Доступно ролям admin и observer.

Тело запроса — объект. Каждый элемент содержит id канала, name для плейлиста и полный address плейлиста на OTT Server:

Окно терминала
curl -sS -X PUT -H "Authorization: Bearer $TOKEN" \
-H 'Content-Type: application/json' \
'http://alta.example.com:8100/api/ott/channel/exportm3u' \
-d '{
"news": {
"id": "news",
"name": "News",
"address": "http://alta.example.com:8101/news/index.m3u8"
}
}'

Ответ (простой текст):

#EXTM3U
#EXTINF:-1 tvg-id="101" catchup="append" catchup-days="2" catchup-source="?start=${start}", News
http://alta.example.com:8101/news/index.m3u8

Подробнее о параметрах плейлиста в разделе Экспорт M3U8.