Start a WebSocket media call

Starts an outbound test call and returns a short-lived WebSocket URL for streaming call audio.

AuthorizationBearer

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

This endpoint expects an object.

modelIdstringRequiredformat: "uuid"

Agent model UUID.

fromPhoneNumberstringRequired

Caller ID for the test call.

toPhoneNumberstringRequired

Destination phone number.

leadNamestringOptional

Lead display name.

agentVersionstringOptional

Agent version to use. Set to draft to test the draft version, pass a version UUID, or omit for the live version.

wsMediaCodecenumOptionalDefaults to opus

Codec to use for the WebSocket media stream.

Allowed values:

WebSocket media call created.

callIdstring

Call ID for looking up the call later.

wsMediaUrlstringformat: "uri"

Short-lived WebSocket URL for streaming call audio.

400

Bad Request Error

401

Unauthorized Error

502

Bad Gateway Error

503

Service Unavailable Error

$	curl -X POST https://api.synthflow.ai/v2/calls/outbound-test-ws-media \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"modelId": "8edd032a-5fef-4847-abe2-55fb16057ece",
>	"fromPhoneNumber": "+15559876543",
>	"toPhoneNumber": "+15551234567",
>	"leadName": "Test Lead",
>	"agentVersion": "draft",
>	"wsMediaCodec": "opus"
>	}'

1	{
2	"callId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
3	"wsMediaUrl": "wss://webrtc-us.synthflow.ai/ws-audio?sid=7f3c9e2a1b0d4f8e"
4	}