Skip to end of metadata
Go to start of metadata

REST method

Params

Returns

Errors

Description

SIP as 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

This method makes a call to SIP.

If rtmpUrl is specified, then media traffic received from SIP will be forwarded to the specified rtmpUrl.

If toStream is specified, /push/startup request can be used to create transponder for the specified stream name to forward media traffic received from SIP.

If call with the same callId, or the same rtmpUrl already exists, 409 Conflict status will be returned.

/call/find_all

void

List<Call>

404 - Call not found

500 - Internal error

Find all SIP calls

/call/find

callId

callee

rtmpUrl

status

List<Call>

404 - Call not found

500 - Internal error

Find SIP calls by filter

/call/terminate

callId

void

404 - Call not found

500 - Internal error

Hangup and terminate the SIP call

/call/send_dtmf

callId

dtmf

type

void

404 - Call not found

500 - Internal error

Send DTMF within the established SIP call

/call/inject_sound

callId

fileName

void

404 - Call not found

404 - File not found

500 - Internal error

Inject audio from the specified file

/call/inject_stream/startup

callId

streamName

void

404 - Call not found

404 - Stream not found

500 - Internal error

Redirecting a stream to a SIP call
/call/inject_stream/terminatecallIdvoid

404 - Call not found

500 - Internal error

Terminate redirecting a stream to a SIP call

RTSP

/rtsp/find

uri

status

List<RtspAgent>

404 - RTSP not found

500 - Internal error

Find RTSP session by filter

/rtsp/find_all

void

List<RtspAgent>

500 - Internal error

Find all RTSP sessions

/rtsp/terminate

uri

void

404 - RTSP not found

500 - Internal error

Stop and terminate RTSP session

/rtsp/startup

uri

void

500 - Internal error

Create a new RTSP session

Streaming

/stream/find_all

void

List<Stream>

404 - Streams not found

500 - Internal error

Find all streams

/stream/find

appKey

name

mediaSessionId

sessionId

status

published

List<Stream>

404 - Stream not found

500 - Internal error

Find streams by filter

/stream/terminate

name

mediaSessionId

List<mediaSessionId>

status

published

void

404 - Stream not found

500 - Internal error

Terminate stream or streams that conforms to query parameters

/stream/snapshotstreamName<Base64 data>404 - Stream not foundMake stream snapshot
/stream/startRecordingmediaSessionIdvoid

404 - Stream not found

500 - Internal error

Start stream recording in specified media session
/stream/stopRecordingmediaSessionIdvoid

404 - Recorder not found

500 - Internal error

Stop stream recording in specified media session
/stream/event/send

streamName

payload

void

404 - Stream not found

500 - Internal error

Send data to all the stream subscribers

Data

/data/send

nodeId

sessionId

operationId

payload

void

500 - Internal error

Send data to connected client

Connection

/connection/terminate

sessionId

void

404 - No such connection

500 - Internal error

Disconnect connected client

/connection/find_all

void

List<Connection>

404 - No connections found

500 - Internal error

Find all connections

/connection/find

appKey

sessionId

clientVersion

List<Connection>

404 - Not found

500 - Internal error

Find connections by filter

Republishing as RTMP

/push/startup

streamName

rtmpUrl

options

Transponder

400 - Bad request

409 - Conflict

500 - Internal error

This method creates transponder, which subscribes to the specified stream and forwards the media traffic to the specified rtmpUrl.

The steam name specified in the request can be that of a published stream, or reserved for a SIP call (to forward media traffic received from SIP).

The options can be used to mute audio, or inject audio from file when transponder is created.

For example,

- "options": {"action": "mute"}

- "options": {"action": "sound_on", "soundFile": "sound.wav", "loop": true}

If transponder for such stream name and rtmpUrl already exist, 409 Conflict status will be returned.

If rtmpUrl is not set, or is set incorrectly and cannot be resolved by DNS, 400 Bad request is returned

/push/find

streamName

rtmpUrl

List<Transponder>

404 - Transponder not found

500 - Internal error

Find transponders by filter

/push/find_all

void

List<Transponder>

404 - Not found any transponder

500 - Internal error

Find all transponders

/push/terminate

mediaSessionId

void

404 - Not found transponder

500 - Internal error

Terminate transponder

/push/mute

mediaSessionId

void

404 - Not found transponder

500 - Internal error

Mute audio

/push/unmute

mediaSessionId

void

404 - Not found transponder

500 - Internal error

Unmute audio

/push/sound_on

mediaSessionId

soundFile

loop

void

404 - Not found transponder

404 - No such file

500 - Internal error

Inject audio from the specified RIFF WAV file located on WCS server in /usr/local/FlashphonerWebCallServer/media/ directory

/push/sound_off

mediaSessionId

void

404 - Not found transponder

500 - Internal error

Stop injecting audio

Pull RTMP

/pull/rtmp/pull

uri

void

409 - Conflict

500 - Internal error

Pull RTMP stream by the specified URL

/pull/rtmp/find_all

void

List<RtmpAgent>

404 - Not found

500 - Internal error

Find all pulled RTMP streams

/pull/rtmp/terminate

uri

void

404 - Not found

500 - Internal error

Terminate pulled RTMP stream

Mixer

/mixer/startup

uri

localStreamName

hasVideo

hasAudio

background

watermark

mixerLayoutClass

void

409 - Conflict

500 - Internal error

Create mixer with the specified stream name

/mixer/add

uri

remoteStreamName

void

404 - Mixer not found

404 - Stream not found

500 - Internal error

Add RTMP stream to mixer

/mixer/remove

uri

remoteStreamName

void

404 - Mixer not found

404 - Stream not found

500 - Internal error

Remove RTMP stream from mixer

/mixer/find_all

void

List<Mixer>

404 - Not found

500 - Internal error

Find all mixers

/mixer/terminate

uri

void

404 - Not found

500 - Internal error

Terminate mixer

/mixer/setAudioVideo

uri

streams

audioLevel

videoMuted

void

200 - OK

400 - Bad request

404 - Not found

500 - Internal error

Mute/unmute video or change audio level for incoming mixer stream

/mixer/test/start

feedingStreams
mixerCount
streamsInMixer
intervalInSeconds

void

404 - Not found

500 - Internal error

Start mixer load test

/mixer/test/stop

void

void

404 - Not found

500 - Internal error

Stop mixer load test

/mixer/test/get_start_examplevoid<MixerTest>

404 - Not found

500 - Internal error

Get sample object to pass to /mixer/test/start method
Pull WebRTC from another WCS

/pull/pull

uri

localStreamName

remoteStreamName

void

409 - Conflict

500 - Internal error

Pull WebRTC stream by specified URL

/pull/push

uri

localStreamName

remoteStreamName

localMediaSessionId

void

409 - Conflict

500 - Internal error

Push WebRTC stream to specified URL

/pull/find_all

void

List<PullAgent>

500 - Internal error

Find all pulled WebRTC streams

/pull/terminate

uri

localMediaSessionId

remoteMediaSessionId

localStreamName

remoteStreamName

status

void

500 - Internal error

Terminate pulled WebRTC stream

Logging management
/logger/enable_client_log

sessionId

logLevel

void

404 - Session not found

Set the specified client log level to the specified session
/logger/disable_client_logsessionIdvoid

404 - Session not found

Fully disable client log in the specified session
CDN
/cdn/show_nodesvoidList<CDNNodes>

500 – Internal Server Error

Show CDN nodes state
/cdn/show_statevoid<processingState>

500 – Internal Server Error

Show CDN node state to which the query was sent
/cdn/enforce_statestatevoid

500 – Internal Server Error

Forcefully set CDN node state
/cdn/show_routesvoidList<CDNRoute>

500 - Internal error

Show CDN routes
/cdn/stream/show_routesstreamName<CDNStreamRoute>

500 - Internal error

Show CDN route to play the stream specified
/cdn/stream/access_list/add

name

keys

void

400 - Bad request

404 - Stream not found

500 – Internal Server Error

Add keys to stream ACL

/cdn/stream/access_list/remove

name

keys

void

400 - Bad request

404 - Stream not found

500 – Internal Server Error

Remove keys from stream ACL

/cdn/stream/access_list/deletenamevoid

400 - Bad request

404 - Stream not found

500 – Internal Server Error

Clean stream ACL

/cdn/stream/access_list/printnameList<key>

404 - ACL not found

500 – Internal Server Error

Show stream ACL
/cdn/profile/add

name

profile:<profile>

void

400 - Bad Request

409 - Conflict

500 – Internal Server Error

Add transcoding profile
/cdn/profile/modify

name

profile:<profile>

void

400 - Bad Request

404 - Not Found

500 – Internal Server Error

Change transcoding profile
/cdn/profile/printvoidList<profile>

404 - Not Found

500 – Internal Server Error

Get the transcoding profiles list
/cdn/profile/removenamevoid

404 - Not Found

500 – Internal Server Error

Remove transcoding profile
/cdn/remove_nodenodeIdvoid

200 – OK

400 - Bad request

404 - Node not found

500 – Internal Server Error

Remove obsolete node from CDN
Stream recording

/recorder/startup


mediaSessionId
config: <Config>

void

404 - Stream not found

500 - Internal error

Start stream recording in specified mediasession


/recorder/terminate

mediaSessionIdvoid

404 - Recorder not found

500 - Internal error

Stop stream recording in specified mediasession
/recorder/find_allvoidList<Recorder>

404 - Recorders not found

500 - Internal error

Find session recordings
Multiple streams recording
/multipleRecorder/startupurivoid

409 - Conflict

500 - Internal error

Launch multiple streams recorder
/multipleRecorder/add

uri
mediaSessionId

void

404 - Not found

409 - Conflict

500 - Internal error

Add the stream with mediaSessionId to the recorder
/multipleRecorder/find_allvoidList<MultipleRecorder>

404 - Not found

500 - Internal error

Find all multiple streamd recorders
/multipleRecorder/removeuri
mediaSessionId
void

404 - Not found

500 - Internal error

Remove the stream with mediaSessionId from the recorder
/multipleRecorder/terminateurivoid

404 - Not found

500 - Internal error

Stop the multiple streams recorder
Transcoding management
/transcoder/startup

uri
remoteStreamName
localStreamName
encoder: <Encoder>

void

409 - Conflict

500 - Internal error

Create transcoder with defined parameters for certain stream
/transcoder/find

uri
remoteStreamName
localStreamName
status

List<Transcoder>

404 – Transcoders not found

Find transcoder by certain criteria
/transcoder/find_allvoidList<Transcoder>

404 – Transcoders not found

Find all transcoders
/transcoder/terminateuri
remoteStreamName
localStreamName
status
void

404 - Transcoder not found

Stop transcoder with its output stream by certain criteria
Transcoding management v 2
/transcoder2/startup

uri
remoteStreamName
localStreamName
encoder: <Encoder>

void

400 - Bad request

409 - Conflict

500 - Internal error

Create transcoder with defined parameters for certain stream
/transcoder2/find

uri
remoteStreamName
localStreamName
status

List<Transcoder>

404 – Transcoders not found

Find transcoder by certain criteria
/transcoder2/find_allvoidList<Transcoder>

404 – Transcoders not found

Find all transcoders
/transcoder2/terminateuri
remoteStreamName
localStreamName
status
void

404 - Transcoder not found

Stop transcoder with its output stream by certain criteria
VOD
/vod/startup

uri
localStreamName

void

409 - Conflict

500 - Internal error

Create VOD live translation from local file or from file at network storage
/vod/find

uri
localStreamName
status
localMediaSessionId

List<VOD>

404 – VODs not found

Find VOD translations by certain criteria
/vod/find_allvoidList<VOD>

404 – VODs not found

Find all VOD translations
/vod/terminate

uri
localStreamName
status
localMediaSessionId

void

404 - VOD not found

Stop VOD translation by certain criteria
HLS
/hls/startupnamevoid

404 - Stream not found

500 - Internal error

Start HLS agent for the stream
/hls/find_allvoidList<HLS>

404 – Not found

Find all streams having HLS agents
/hls/terminatenamevoid

404 – Not found

Stop or restart HLS agent for the stream