Overview
This API describes the WebSocket-based communication for AgentVB Middleware, enabling client-side initiation of verification flows and receiving streaming server-side updates. The WebSocket server automatically begins sending messages upon successful connection and authentication. Clients send a single CommandRequestMessage to initiate commands like GET_VERIFICATION or GET_ECHO. All server-pushed messages follow a SimpleWsMessage<T> envelope: { "topic": "", "data": { ... } }.
Message Flow Explanation
-
RECEIVE: These events are used for the server to receive messages from the client. Clients utilize these events to initiate requests such as verification or status updates.
-
SEND: These events are used for the server to send responses back to the client. Responses may include verification scores, call status, TTS detection results, and more, which are received by the client.