Table of Contents

/call/startup

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/call/startup HTTP/1.1
HOST: 192.168.1.59:8081
content-length: 417
content-type: application/json

{
	"callId":"123456711",
	"callee":"10000",
	"rtmpUrl":"rtmp://localhost:1935/live",
	"rtmpStream":"stream1",
	"hasAudio":"true",
	"hasVideo":"true",
	"sipLogin":"10009",
	"sipAuthenticationName":"10009",
	"sipPassword":"1234",
	"sipDomain":"226.226.225.226",
	"sipOutboundProxy":"226.226.225.226",
	"sipPort":"5060",
	"appKey":"defaultApp",
	"sipRegisterRequired":"false",
	"visibleName":"WCS_10009"
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Length: 0
Date: Mon, 27 Mar 2017 03:23:54 GMT

/call/find_all

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/call/find_all HTTP/1.1
Host: 192.168.1.101:8081
Content-Length: 0
Content-Type: application/json

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: application/json;charset=UTF-8
Date: Tue, 28 Mar 2017 12:13:24 GMT

[
	{
		"custom" {},
		"nodeId":null,
		"appKey":null,
		"sessionId":null,
		"callId":"83077OWQzZTRkNzIzNjk1NTI5NmUwZWFlOGU1MWU0NDVkN2U",
		"parentCallId":null,
		"incoming":true,
		"status":"ESTABLISHED",
		"sipStatus":null,
		"rtmpUrl":null,
		"rtmpStream":null,
		"rtmpStreamStatus":null,
		"caller":"005",
		"callee":"001",
		"hasAudio":true,
		"hasVideo":true,
		"sdp":".....",
		"visibleName":"005",
		"inviteParameters":null,
		"mediaProvider":"WebRTC",
		"sipMessageRaw":".....",
		"isMsrp":false,
		"target":null,
		"holdForTransfer":false
		},{
		"custom":{},
		"nodeId":null,
		"appKey":null,
		"sessionId":null,
		"callId":"e9516680-13af-11e7-af37-05c788b22e35",
		"parentCallId":null,
		"incoming":false,
		"status":"RING",
		"sipStatus":180,
		"rtmpUrl":null,
		"rtmpStream":null,
		"rtmpStreamStatus":null,
		"caller":"002",
		"callee":"005",
		"hasAudio":true,
		"hasVideo":false,
		"sdp":null,
		"visibleName":"002",
		"inviteParameters":null,
		"mediaProvider":"WebRTC",
		"sipMessageRaw":null,
		"isMsrp":false,
		"target":null,
		"holdForTransfer":false
	}
]

/call/find

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/call/find HTTP/1.1
Host: 192.168.1.101:8081
Content-Length: 70
Content-Type: application/json

{
	"status" : "ESTABLISHED",
	"rtmpUrl" : "rtmp://localhost:1935/live"
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: application/json;charset=UTF-8
Date: Tue, 28 Mar 2017 12:37:55 GMT

[
	{
		"custom":{},
		"nodeId":null,
		"appKey":null,
		"sessionId":null,
		"callId":"MzEjol9dY-TIg9FpAy-J3YmhDbyY-g7w771EDq",
		"parentCallId":null,
		"incoming":false,
		"status":"ESTABLISHED",
		"sipStatus":200,
		"rtmpUrl":"rtmp://localhost:1935/live",
		"rtmpStream":"stream1",
		"rtmpStreamStatus":"RTMP_STREAM_ACTIVE",
		"caller":"001",
		"callee":"005",
		"hasAudio":true,
		"hasVideo":true,
		"sdp":null,
		"visibleName":"001",
		"inviteParameters":null,
		"mediaProvider":"Flash",
		"sipMessageRaw":null,
		"isMsrp":false,
		"target":null,
		"holdForTransfer":false
	}
]

/call/terminate

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/call/terminate HTTP/1.1
Host: 192.168.1.101:8081
Content-Length: 53
Content-Type: application/json

{
	"callId" : "yOh8vRDfr-lko7fXTg-pKJDHXQ-TW8PhcS"
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Length: 0
Date: Tue, 28 Mar 2017 12:48:29 GMT

/call/send_dtmf

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/call/send_dtmf HTTP/1.1
Host: 192.168.1.101:8081
Content-Length: 83
Content-Type: application/json

{
	"callId" : "yOh8vRDfr-lko7fXTg-pKJDHXQ-TW8PhcS",
	"dtmf":"9",
	"type":"RFC2833"
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Length: 0
Date: Tue, 28 Mar 2017 13:00:34 GMT

/call/inject_sound

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/call/inject_sound HTTP/1.1
Host: 192.168.1.101:8081
Content-Type: application/json;charset=UTF-8
Content-Length: 69

{
	"callId":"yOh8vRDfr-lko7fXTg-pKJDHXQ-TW8PhcS",
	"fileName":"test.wav"
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Length: 0
Date: Thu, 23 Nov 2017 09:37:23 GMT

/call/inject_stream/startup

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/call/inject_stream/startup HTTP/1.1
Host: 192.168.1.101:8081
Content-Type: application/json;charset=UTF-8
Content-Length: 69

{
	"callId":"yOh8vRDfr-lko7fXTg-pKJDHXQ-TW8PhcS",
	"streamName":"mixer1"
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Length: 0
Date: Thu, 23 Nov 2017 09:47:57 GMT

/call/inject_stream/terminate

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/call/inject_stream/terminate HTTP/1.1
Host: 192.168.1.101:8081
Content-Type: application/json;charset=UTF-8
Content-Length: 50

{
	"callId":"yOh8vRDfr-lko7fXTg-pKJDHXQ-TW8PhcS"
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Length: 0
Date: Thu, 23 Nov 2017 12:42:52 GMT

/rtsp/startup

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/rtsp/startup HTTP/1.1
Host: 192.168.1.101:8081
Content-Length: 56
Content-Type: application/json

{
	"uri": "rtsp://s1.media-planet.sk:80/live/bardejov1"
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Length: 0
Date: Tue, 28 Mar 2017 13:18:01 GMT

/rtsp/find_all

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/rtsp/find_all HTTP/1.1
Host: 192.168.1.101:8081
Content-Length: 0
Content-Type: application/json

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: application/json;charset=UTF-8
Date: Tue, 28 Mar 2017 14:47:08 GMT

[
	{
	"uri":"rtsp://s1.media-planet.sk:80/live/bardejov1","status":"PLAYING"
	},{
	"uri":"rtsp://str81.creacast.com/grandlilletv/high","status":"PLAYING"
	}
]

/rtsp/find

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/rtsp/find HTTP/1.1
Host: 192.168.1.101:8081
Content-Length: 72
Content-Type: application/json

{
"uri":"rtsp://str81.creacast.com/grandlilletv/high","status":"PLAYING"
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: application/json;charset=UTF-8
Date: Tue, 28 Mar 2017 14:57:05 GMT

[
	{
		"uri":"rtsp://str81.creacast.com/grandlilletv/high","status":"PLAYING"
	}
]

/rtsp/terminate

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/rtsp/terminate HTTP/1.1
Host: 192.168.1.101:8081
Content-Length: 53
Content-Type: application/json

{
	"uri":"rtsp://s1.media-planet.sk:80/live/bardejov1"
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Length: 0
Date: Tue, 28 Mar 2017 15:02:07 GMT

/stream/find_all

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/stream/find_all HTTP/1.1
Host: 192.168.1.101:8081
Content-Length: 0
Content-Type: application/json

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: application/json;charset=UTF-8
Date: Tue, 28 Mar 2017 15:10:38 GMT

[
	{
		"custom":{},
		"nodeId":null,
		"appKey":"defaultApp",
		"sessionId":"/192.168.1.102:13252/192.168.1.101:8443",
		"mediaSessionId":"9e7a6da0-13c8-11e7-a92a-b50084e40e7d",
		"remoteMediaElementId":null,
		"name":"stream1",
		"published":false,
		"hasVideo":true,
		"hasAudio":true,
		"status":"PLAYING",
		"sdp":".....",
		"info":null,
		"record":false,
		"recordName":null,
		"width":0,
		"height":0,
		"bitrate":0,
		"quality":0,
		"rtmpUrl":null,
		"streamInfo":{
		    "custom":{},
		    "nodeId":null,
		    "appKey":null,
		    "sessionId":null,
		    "mediaSessionId":"9e7a6da0-13c8-11e7-a92a-b50084e40e7d",
		    "name":"stream1",
		    "samplingTime":null,
		    "recordTimestamp":null,
		    "recordStarted":false
		},
		"mediaProvider":"WebRTC"
		},{
			"custom":{},
			"nodeId":null,
			"appKey":"flashStreamingApp",
			"sessionId":"398c1948-5510-4842-b647-53c2f0d36c45",
			"mediaSessionId":"06844ffd-1dce-4a77-a2c2-37629f0e4d13",
			"remoteMediaElementId":null,
			"name":"stream1",
			"published":true,
			"hasVideo":false,
			"hasAudio":true,
			"status":"PUBLISHING",
			"sdp":".....",
			"info":null,
			"record":false,
			"recordName":null,
			"width":0,
			"height":0,
			"bitrate":0,
			"quality":0,
			"rtmpUrl":null,
			"streamInfo":{
		    "custom":{},
		    "nodeId":null,
		    "appKey":null,
		    "sessionId":null,
		    "mediaSessionId":"06844ffd-1dce-4a77-a2c2-37629f0e4d13",
		    "name":"stream1",
		    "samplingTime":null,
		    "recordTimestamp":null,
		    "recordStarted":false
		},
		"mediaProvider":"Flash"
	}
]

/stream/find

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/stream/find HTTP/1.1
Host: 192.168.1.101:8081
Content-Length: 40
Content-Type: application/json

{
	"name":"stream1",
	"published":true
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: application/json;charset=UTF-8
Date: Tue, 28 Mar 2017 16:05:16 GMT

[{
"custom":{},
"nodeId":null,
"appKey":"defaultApp",
"sessionId":"/192.168.1.102:34500/192.168.1.101:8080",
"mediaSessionId":"4f112b20-13d0-11e7-b521-59a9cb7eddeb",
"remoteMediaElementId":null,
"name":"stream1",
"published":true,
"hasVideo":true,
"hasAudio":true,
"status":"PUBLISHING",
"sdp":".....",
"info":null,
"record":true,
"recordName":"stream-4f112b20-13d0-11e7-b521-59a9cb7eddeb-737lrm8t053nlg8c2n23ctco33.mp4",
"width":0,
"height":0,
"bitrate":0,
"quality":0,
"rtmpUrl":null,
"streamInfo":{
    "custom":{},
    "nodeId":null,
    "appKey":null,
    "sessionId":null,
    "mediaSessionId":"4f112b20-13d0-11e7-b521-59a9cb7eddeb",
    "name":"stream1",
    "samplingTime":1490717116551,
    "recordTimestamp":7640,
    "recordStarted":true
},
"mediaProvider":"Flash"
}]

/stream/terminate

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/stream/terminate HTTP/1.1
Host: 192.168.1.101:8081
Content-Length: 57
Content-Type: application/json

{
	"mediaSessionId":"4f112b20-13d0-11e7-b521-59a9cb7eddeb"
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Length: 0
Date: Tue, 28 Mar 2017 16:11:48 GMT

...

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/mixer/find_all HTTP/1.1
HOST: 192.168.1.101:8081
content-type: application/json
content-length: 0

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: application/json;charset=UTF-8
Date: Fri, 24 Nov 2017 15:01:23 GMT

[{
"localMediaSessionId":"b38c284d-2d8c-4c1b-9a9b-c3049e5fe870",
"remoteMediaSessionId":null,
"localStreamName":"mixer2",
"remoteStreamName":null,
"uri":"mixer://mixer2",
"status":"PROCESSED_LOCAL",
"mediaSessions":[]
},{
"localMediaSessionId":"cafdd756-3451-4c0c-bf04-049cc2d5994a",
"remoteMediaSessionId":null,
"localStreamName":"mixer1_stream",
"remoteStreamName":null,
"uri":"mixer://mixer1",
"status":"PROCESSED_LOCAL",
"mediaSessions":[]
}]

/mixer/terminate

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/mixer/terminate HTTP/1.1
HOST: 192.168.1.101:8081
content-type: application/json
content-length: 31

{
	"uri": "mixer://mixer1"
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Length: 0
Date: Fri, 24 Nov 2017 14:55:35 GMT

/mixer/test/start

Request

Response

Code Block

language	js
theme	RDark

POST /rest-api/mixer/test/start HTTP/1.1
HOST: 192.168.1.101:8081
Content-type: application/json
Content-length: 107

{
	"feedingStreams": [
		"s1",
		"s2"
    ],
    "mixerCount": 3,
    "streamsInMixer": 1,
    "intervalInSeconds": 60
}

Code Block

language	js
theme	RDark

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Length: 0
Date: Wed, 22 Aug 2018 08:53:26 GMT

...

Space shortcuts

Page tree

Versions Compared

Old Version 27

New Version 28

Key

/call/startup

/call/find_all

/call/find

/call/terminate

/call/send_dtmf

/call/inject_sound

/call/inject_stream/startup

/call/inject_stream/terminate

/rtsp/startup

/rtsp/find_all

/rtsp/find

/rtsp/terminate

/stream/find_all

/stream/find

/stream/terminate

/mixer/terminate

/mixer/test/start

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 27

New Version 28

Key

/call/startup

/call/find_all

/call/find

/call/terminate

/call/send_dtmf

/call/inject_sound

/call/inject_stream/startup

/call/inject_stream/terminate

/rtsp/startup

/rtsp/find_all

/rtsp/find

/rtsp/terminate

/stream/find_all

/stream/find

/stream/terminate

/mixer/terminate

/mixer/test/start