WCS integrates with the back-end server using REST / HTTP calls or REST Methods as we call them.
Therefore, you provide the WCS server with the script API, and WCS sends data on connections, calls, video streams etc. to the API.
REST methods can be used to:
- Authenticate connections to the server by token or by password
- Receive real-time information about connects, disconnects, started and ended streams, calls and so on.
- Redefine data received from the client. For example, you can rename a stream or hide its real name or redirect a call.
- Implement custom signaling with Websockets transmission of data. For example, send a text message in the chat to all connected clients.
REST methods should be implemented as simple HTTP / HTTPS scripts that work in pair with JSON in the body of an HTTP request and return JSON in the HTTP body of responses.
Request
Protocol | HTTP / HTTPS |
|---|---|
URL | http://path/method или https://path/method |
Method | POST |
Content-Type | application/json |
Body | JSON |
Response
In response, WCS should receive a standard HTTP response containing the body of JSON
status | 200 |
Reason phrase | OK |
Body | JSON |