Call control

The call API addresses a call by its Leamout call ID. The supported actions are:

POST /v1/calls/{id}/answer
POST /v1/calls/{id}/hangup
POST /v1/calls/{id}/transfer
POST /v1/calls/{id}/hold
POST /v1/calls/{id}/unhold
POST /v1/calls/{id}/play
POST /v1/calls/{id}/stop
POST /v1/calls/{id}/record
POST /v1/calls/{id}/dtmf

Examples of action bodies:

Action	JSON body
Transfer	`{"destination":"1001"}`
Play	`{"path":"/path/to/media.wav"}`
Record	`{"path":"/path/to/recording.wav","action":"start"}`
DTMF	`{"digits":"1234#"}`

The transfer request supports a destination field; older dialplan and context examples are not part of the current request type. Other actions may not require a request body. Call-control requests are checked against the current call state. Use an optional Idempotency-Key header when retrying supported call mutations.

Get started

Voice Agents

Calling

SIP connectivity

Data & security

Usage

Webhooks

Reference