Supervisor Session
Create a new supervisor session.
POST /api/v2/supervisor_session
This request requires a proper auth-token.
Request Parameters | Type | Description |
---|---|---|
client_id | String (required) | ClientID of the supervisor. |
client_id_to_monitor | String (required) | ClientID of the client the supervisor wants to monitor. |
session_id_to_monitor | String (optional) | SessionID the supervisor intends to monitor. Note, that this is optional. If not specified the active session will be automatically determined. |
Example request:
{
"client_id":"sup-0",
"client_id_to_monitor":"client-0"
}
Returns 201 on success.
Response Parameters | Type | Description |
---|---|---|
session_id | String | ID of this supervisor session. |
session_id_to_monitor | String | SessionID which is monitored. If this was specified already during the request it will match that one. If left empty, it will contain the determined sessionID of the client to be monitored. |
ice_credentials | RTCIceServer | Ice server address and credentials. |
ws_endpoint | String | Address of the websockets endpoint. |
Example response:
{
"ice_credentials": {
"iceServers": [
{
"urls": [
"stun:nuts.eyeson.com:3478"
],
"username": "",
"credential": ""
},
{
"urls": [
"turn:nuts.eyeson.com:3478",
"turn:nuts.eyeson.com:3478?transport=tcp",
"turn:nuts.eyeson.com:443?transport=tcp"
],
"username": "**********************",
"credential": "*******************"
}
]
},
"session_id": "5061fd09-834c-1efa-be18-4a08eb54996f",
"ws_endpoint": "wss://streamrec.eyeson.com/api/v2/supervisor_io/6760fea3-589c-4253-b1c6-3d87123be956",
"session_id_to_monitor": "6760fea3-589c-4253-b1c6-3d87123be956"
}