Skip to main content
POST
Create a call for your own telephony

Authorizations

X-API-Key
string
header
required

API key for authentication

Body

application/json
agentId
string
required

The agent to run this call. Must be ACTIVE.

connectionType
enum<string>
default:twilio

Which transport the returned websocketUrl is prepared for.

twilio / telnyx / plivo — carrier media streams, G.711 audio. websocket — your own client; you choose the sample rates and codec. webrtc — browser transport, normally reached through the SDK.

Any other value returns 400.

Available options:
twilio,
telnyx,
plivo,
websocket,
webrtc
websocket
object

Audio parameters. Only read when connectionType is websocket — telephony transports force G.711 at 8000 Hz regardless of what is sent here.

metadata
object

Arbitrary values carried on the call record.

Response

Call session created

id
string
websocketUrl
string

Short-lived, single-use URL to stream audio to. This is the field to read — there is no joinUrl in the response.

status
string
connectionType
string
agent
object
createdAt
string<date-time>