start a conference listen fork

Streams the conference’s mixed audio (L16 PCM) to the supplied WebSocket URL. Addressed by conference name — no participant call leg is required. The fork is media-server-owned: it is excluded from participant counts, never keeps a room alive, and is torn down automatically when the conference ends. Starting a fork for a conference that already has one is idempotent and returns the existing bot member (200 rather than 201).

Streams the conference's mixed audio (L16 PCM) to the supplied WebSocket URL. Addressed by conference name — no participant call leg is required. The fork is media-server-owned: it is excluded from participant counts, never keeps a room alive, and is torn down automatically when the conference ends. Starting a fork for a conference that already has one is idempotent and returns the existing bot member (200 rather than 201).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

AccountSidstringRequired

ConferenceNamestringRequired

Request

This endpoint expects an object.

urlstringRequired

ws(s):// URL the media server streams the room mix to

sampleRateintegerOptional

PCM sample rate of the fork (e.g. 8000, 16000)

wsAuthobjectOptional

HTTP basic-auth credentials presented on the WebSocket connection

metadataobjectOptional

Arbitrary JSON delivered verbatim as the fork's first text frame, so the receiving WebSocket can identify and configure itself

Response

a listen fork is already active for this conference (idempotent)

botMemberIdinteger

botIdstring

Errors

400

Bad Request Error

404

Not Found Error

502

Bad Gateway Error

$	curl -X POST https://api.jambonz.cloud/v1/Accounts/AccountSid/Conferences/ConferenceName/listen \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"url": "wss://audio-streaming.example.com/conference123/mix"
>	}'