REST-метод | Параметры | Возвращаемый тип | Ошибки | Описание |
---|---|---|---|---|
SIP как RTMP | ||||
/call/startup | callId callee rtmpStream rtmpUrl hasAudio hasVideo sipLogin sipAuthenticationName sipPassword sipDomain sipOutboundProxy sipPort appKey sipRegisterRequired toStream visibleName | void | 409 - Conflict 500 - Internal error | Делает вызов на SIP. Если указан rtmpUrl, то медиа трафик, полученный со стороны SIP, отправляется на указанный rtmpUrl. Если указан toStream, то для отправки медиа трафика, полученного со стороны SIP, можно использовать метод /push/startup, чтобы создать транспондер для указанного имени потока. Если уже есть звонок с таким callId или rtmpUrl, возвращает 409 Conflict. |
/call/find_all | void | List<Call> | 404 - Call not found 500 - Internal error | Получить список всех SIP-звонков |
/call/find | callId callee rtmpUrl status | List<Call> | 404 - Call not found 500 - Internal error | Получить список звонков, найденных по фильтру |
/call/terminate | callId | void | 404 - Call not found 500 - Internal error | Сбросить SIP-звонок |
/call/send_dtmf | callId dtmf type | void | 404 - Call not found 500 - Internal error | Отправить DTMF внутри SIP-звонка |
/call/inject_stream | callId streamName | void | 404 - Call not found 404 - Stream not found 500 - Internal error | Вставить аудио из указанного потока |
/call/inject_sound | callId fileName | void | 404 - Call not found 404 - File not found 500 - Internal error | Вставить аудио из указанного файла |
RTSP | ||||
/rtsp/find | uri status | List<RtspAgent> | 404 - RTSP not found 500 - Internal error | Поиск RTSP-сессии по фильтру |
/rtsp/find_all | void | List<RtspAgent> | 500 - Internal error | Получить все RTSP-сессии |
/rtsp/terminate | uri | void | 404 - RTSP not found 500 - Internal error | Остановить RTSP-сессию |
/rtsp/startup | uri | void | 500 - Internal error | Создать RTSP-сессию |
Потоковое вещание | ||||
/stream/find_all | void | List<Stream> | 404 -Streams not found 500 - Internal error | Найти все потоки |
/stream/find | name mediaSessionId status published | List<Stream> | 404 - Stream not found 500 - Internal error | Найти потоки по фильтру |
/stream/terminate | name mediaSessionId List<mediaSessionId> status published | void | 404 - Stream not found | Завершить работу потока или потоков, соответствующих указанным параметрам |
/stream/snapshot | streamName | <Base64 data> | 404 - Stream not found | Снять превью указанного потока |
/stream/startRecording | mediaSessionId | void | 404 - Not found 500 - Internal error | Начать запись потока в указанной медиасессии |
/stream/stopRecording | mediaSessionId | void | 404 - Not found 500 - Internal error | Завершить запись потока в указанной медиасессии |
Данные | ||||
/data/send | nodeId sessionId operationId payload | void | 500 - Internal error | Отправить данные подключенному клиенту |
Соединение | ||||
/connection/terminate | sessionId | void | 404 - No such connection | Выполнить дисконнект клиента |
/connection/find_all | void | List<Connection> | 404 - No connections found 500 - Internal error | Получить список всех коннектов к серверу |
/connection/find | appKey sessionId clientVersion clientType protocol | Найти коннекты по фильтру | ||
Републикация как RTMP | ||||
/push/startup | streamName rtmpUrl options | Transponder | 409 - Conflict 500 - Internal error | Создает транспондер, который подписывается на указанный поток и отправляет медиа трафик на указанный rtmpUrl. Имя потока, указанное в запросе, может быть именем уже публикуемого потока или именем зарезервированным при создании SIP-звонка (для отправки медиа трафика, полученного со стороны SIP). Параметр options может быть использован, чтобы выключить аудио или вставить аудио из файла при создании транспондера. Например, - "options": {"action": "mute"} - "options": {"action": "sound_on", "soundFile": "sound.wav", "loop": true} Если транспондер для такого потока и rtmpUrl уже существует, возвращает 409 Conflict. |
/push/find | streamName rtmpUrl | List<Transponder> | 404 - Transponder not found 500 - Internal error | Найти транспондеры по фильтру |
/push/find_all | void | List<Transponder> | 404 - Not found any transponder 500 - Internal error | Найти все транспондеры |
/push/terminate | mediaSessionId | void | 404 - Not found transponder 500 - Internal error | Завершить работу транспондера |
/push/mute | mediaSessionId | void | 404 - Not found transponder 500 - Internal error | Выключить аудио |
/push/unmute | mediaSessionId | void | 404 - Not found transponder 500 - Internal error | Включить аудио |
/push/sound_on | mediaSessionId soundFile loop | void | 404 - Not found transponder 404 - No such file 500 - Internal error | Вставить аудио из RIFF WAV файла из директории /usr/local/FlashphonerWebCallServer/media/ на WCS-сервере |
/push/sound_off | mediaSessionId | void | 404 - Not found transponder 500 - Internal error | Завершить вставку аудио из файла |
Извлечение RTMP-потока | ||||
/pull/rtmp/pull | uri record | void | 409 - Conflict 500 - Internal error | Извлечь RTMP-поток по указанному URL |
/pull/rtmp/find_all | void | List<RtmpAgent> | 404 - Not found 500 - Internal error | Найти все извлеченные RTMP-потоки |
/pull/rtmp/terminate | uri | void | 404 - Not found 500 - Internal error | Завершить работу извлеченного RTMP-потока |
Микшер | ||||
/mixer/startup | uri localStreamName | void | 409 - Conflict 500 - Internal error | Создает микшер, для которого публикуется поток с указанным именем |
/mixer/add | uri remoteStreamName | void | 404 - Mixer not found 404 - Stream not found 500 - Internal error | Добавить RTMP-поток в микшер |
/mixer/remove | uri remoteStreamName | void | 404 - Mixer not found 404 - Stream not found 500 - Internal error | Убрать RTMP-поток из микшера |
/mixer/find_all | void | List<Mixer> | 404 - Not found 500 - Internal error | Найти все микшеры |
/mixer/terminate | uri | void | 404 - Not found 500 - Internal error | Завершить работу микшера |
/mixer/test/start | feedingStreams | void | 404 - Not found 500 - Internal error | Запустить нагрузочный тест микшера |
/mixer/test/stop | void | void | 404 - Not found 500 - Internal error | Остановить нагрузочный тест микшера |
/mixer/test/get_start_example | void | <MixerTest> | 404 - Not found 500 - Internal error | Получить пример объекта, передаваемого на вход методу /mixer/test/start |
Извлечение/ретрансляция потока по WebRTC с другого WCS сервера | ||||
/pull/pull | uri localStreamName remoteStreamName | void | 409 - Conflict 500 - Internal error | Извлечь WebRTC-поток по указанному URL |
/pull/push | uri localStreamName remoteStreamName localMediaSessionId | void | 409 - Conflict 500 - Internal error | Транслировать WebRTC-поток по указанному URL |
/pull/find_all | void | List<PullAgent> | 200 – OK 500 - Internal error | Найти все извлеченные WebRTC-потоки |
/pull/terminate | uri localMediaSessionId remoteMediaSessionId localStreamName remoteStreamName status | void | 200 – OK 500 - Internal error | Завершить извлеченный WebRTC-поток |
Служебные функции | ||||
/api/create-session | appKey clientBrowserVersion clientVersion mediaProviders sipLogin sipAuthenticationName sipPassword sipDomain sipOutboundProxy sipPort sipRegisterRequired urlServer | void | 200 - OK 500 - Internal error | Подключиться к указанному серверу и создать сессию |
Управление логированием | ||||
/logger/enable_client_log | sessionId logLevel | void | 200 - OK 404 - Session not found | Включить указанный уровень клиентского лога в заданной сессии |
/logger/disable_client_log | sessionId | void | 200 - OK 404 - Session not found | Полностью отключить клиентский лог в заданной сессии |
CDN | ||||
/cdn/show_routes | void | List<CDNRoute> | 200 - OK 500 - Internal error | Показать список маршрутов CDN |
/cdn/stream/show_routes | streamName | <CDNStreamRoute> | 200 - OK 500 - Internal error | Показать маршрут CDN для воспроизведения заданного потока |
Управление транскодером | ||||
/transcoder/startup | uri | void | 409 - Conflict 500 - Internal error | Создать транскодер с указанными параметрами для заданного потока |
/transcoder/find | uri | List<Transcoder> | 200 – Transcoders found 404 – Transcoders not found | Найти транскодер по указанным критериям |
/transcoder/find_all | void | List<Transcoder> | 200 – Transcoders found 404 – Transcoders not found | Найти все транскодеры |
/transcoder/terminate | uri remoteStreamName localStreamName status | void | 200 - Transcoders is terminated 404 - Transcoder not found | Остановить транскодер с выходным потоком, подходящим под указанные критерии |
VOD | ||||
/vod/startup | uri | void | 409 - Conflict 500 - Internal error | Создать VOD live трансляцию из локального файла или файла в сетевом хранилище |
/vod/find | uri | List<VOD> | 200 – VODs found 404 – VODs not found | Найти VOD трансляцию по указанным критериям |
/vod/find_all | void | List<VOD> | 200 – VODs found 404 – VODs not found | Найти все VOD трансляции |
/vod/terminate | uri | void | 200 - VODs is terminated 404 - VOD not found | Остановить VOD трансляцию, подходящую под указанные критерии |
Overview
Content Tools