Method ws_transcription

The method ws_transcription opens a WebSocket connection with your Basix PBX. This WebSocket connection will permit to receive notification of real-time call transcription in your PBX.

Parameters

Parameter Name Description Allowed Values Default Value Optional
filter used to filter by specific call UUIDs 'any' (will get transcriptions for all calls being transcripted in the PBX) or single call UUID like 'add7b23e-c172-445e-832e-963b11ba2b96' or list of call UUIDs like 'add7b23e-c172-445e-832e-963b11ba2b96,cc46fc4b-a42f-410e-82b5-11aa2a1f69fe' None No

The parameters are passed in the URL like this:

wss://bcs.brastel.com/basix/api/ws_transcription?filter=any

Obs: this only permits to monitor call transcriptions. For call transcription to actually happen it must be enabled for the desired users.