Соответствие между клиентскими вызовами и REST-методами¶
В таблице перечислены методы, их типы, соответствующие REST-методы и события, которые связаны с этими REST-методами. В поле Web SDK показано, как вызов методов и обработка событий выглядит
на стороне клиента.
| Description | Web SDK | REST hook | Events |
|---|---|---|---|
| connect | |||
| Установить соединение с WCS |
Flashphoner.createSession()
|
connect | ConnectionStatusEvent, RegistrationStatusEvent |
| Прямые вызовы - Стриминг | |||
| Проиграть поток |
stream.play()
|
playStream | StreamStatusEvent |
| Поставить на паузу воспроизведение потока |
stream.pause()
|
pauseStream | StreamStatusEvent |
| Остановить воспроизведение потока |
stream.stop()
|
stopStream | StreamStatusEvent |
| Опубликовать поток |
stream.publish()
|
publishStream | StreamStatusEvent |
| Сохранить снапшот потока |
stream.snapshot()
|
snapshot | StreamStatusEvent |
| Завершить публикацию потока |
stream.stop()
|
unPublishStream | StreamStatusEvent |
| Прямые вызовы - Звонки | |||
| Сделать исходящий звонок |
call.call()
|
call | CallStatusEvent |
| Отправить тональный сигнал (DTMF) |
call.sendDTMF()
|
sendDtmf | \- |
| Ответить на входящий звонок |
call.answer()
|
answer | CallStatusEvent |
| Поставить звонок на удержание |
call.hold()
|
hold | CallStatusEvent |
| Снять звонок с удержания |
call.unhold()
|
unhold | CallStatusEvent |
| Перевести звонок на другой номер |
call.transfer()
|
transfer | TransferStatusEvent |
| Завершить звонок |
call.hangup()
|
hangup | CallStatusEvent |
| Входящие вызовы - Звонки | |||
| Принять входящий звонок |
session.on(SESSION_STATUS.INCOMING_CALL, handler)
|
OnCallEvent, CallStatusEvent | |
| Прямые и входящие вызовы - Данные | |||
| Отправить данные |
session.sendData()
|
OnDataEvent, DataStatusEvent | |
| Принять данные |
session.on(SESSION_STATUS.APP_DATA, handler)
|
OnDataEvent, DataStatusEvent | |
| Прямые вызовы - Диагностика | |||
| Отправить отчет об ошибке для сохранения на сервере |
session.submitBugReport()
|
submitBugReport | BugReportStatusEvent |
| Сохранить логи клиента на сервере |
session.pushLogs()
|
pushLogs | \- |
| Включить отладочные логи для стриминга |
session.startDebug()
|
sessionDebug | SessionDebugStatusEvent |
| Выключить отладочные логи для стриминга |
session.stopDebug()
|
sessionDebug | SessionDebugStatusEvent |
| События websocket сессии | |||
| Статус соединения |
session.on(SESSION_STATUS...., handler)
|
ConnectionStatusEvent | ConnectionStatusEvent |
| Статус регистрации на SIP сервере |
session.on(SESSION_STATUS...., handler)
|
RegistrationStatusEvent | RegistrationStatusEvent |
| Статус отладки сессии |
session.on(SESSION_STATUS.DEBUG, handler)
|
SessionDebugStatusEvent | SessionDebugStatusEvent |
| События медиапотока | |||
| Статус потока |
stream.on(STREAM_STATUS....,handler)
|
StreamStatusEvent | StreamStatusEvent |
| События звонка | |||
| Статус звонка |
call.on(CALL_STATUS....,handler)
|
CallStatusEvent | CallStatusEvent |
| Другие события | |||
| Событие, отправляемое сервером на бэкенд во время публикации / воспроизведения потока | Not used by the client | StreamKeepAliveEvent | StreamKeepAliveEvent |