Track Share Status (WSS)

Real-time status updates for a shared stream session via WebSocket.

Detail Specification
Protocol WSS
Base URL ``
Security Share ID via query parameter
Frequency 1 Hz

Connection URL

?token=<JWT_TOKEN>&resourceId=<SHARE_ID>
Parameter Description
token Your JWT access token
resourceId The share ID to subscribe to

Connection Example

const ws = new WebSocket(
  '?token=' + accessToken + '&resourceId=' + shareId
);

ws.onmessage = (event) => {
  const status = JSON.parse(event.data);
  console.log(status);
};

Message Payload

Payload content is dynamically filtered according to the role defined when creating the share.


IDI Integration API Documentation © 2025