POST
/
v1
/
calls
Start a call
curl --request POST \
  --url https://api.wavix.com/v1/calls \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from": "+1234567890",
  "to": "+1987654321",
  "callback_url": "https://examples.com/callback",
  "recording": false,
  "voicemail_detection": false,
  "tag": "marketing-campaign",
  "timeout": 60
}
'
{
  "uuid": "5dccb6b0-f35c-488c-867b-86fb012c4415",
  "direction": "inbound",
  "event_type": "call_setup",
  "event_time": "2025-09-22T12:56:38.547Z",
  "event_payload": null,
  "from": "+18045961058",
  "to": "17653889567",
  "call_started": "2025-09-22T12:56:38.547Z",
  "call_answered": "2023-06-15T10:30:00Z",
  "call_completed": "2023-06-15T10:30:00Z",
  "machine_detected": false,
  "tag": ""
}

Authorizations

​
Authorization
string
header
required

Wavix API key. Pass as Authorization: Bearer <api_key>. Keys support per-resource scopes (none / read / write). See Restricted keys and scopes.

Body

application/json

Attributes for the new outbound call.

​
from
string
required

Caller ID. Must be an active or verified phone number on the account.

Example:

"+1234567890"

​
to
string
required

Destination number in E.164 format

Example:

"+1987654321"

​
callback_url
string
required

The callback URL where Wavix sends the call status updates

Example:

"https://examples.com/callback"

​
recording
boolean
default:false

Specifies whether to record the call

​
voicemail_detection
boolean
default:false

Specifies whether the AMD is turned on for the call

​
tag
string

Call metadata

Example:

"marketing-campaign"

​
timeout
integer

The ring timeout, in seconds, before the call is considered unanswered.

Example:

60

Response

Returns the created call.

​
uuid
string<uuid>
deprecated

Call ID. Deprecated — use id instead.

Example:

"5dccb6b0-f35c-488c-867b-86fb012c4415"

​
id
string<uuid>

Call ID. Alias of uuid.

Example:

"5dccb6b0-f35c-488c-867b-86fb012c4415"

​
direction
enum<string>

Direction of the call. One of inbound (call received by the account) or outbound (call placed by the account).

Available options:
inbound,
outbound
​
event_type
enum<string>

Most recent lifecycle event for the call. One of:

  • call_setup — the call is being initiated.
  • ringing — the destination is ringing.
  • early_media — early media (such as ringback) is playing before answer.
  • answered — the destination answered the call.
  • completed — the call ended normally.
  • busy — the destination was busy.
  • cancelled — the call was cancelled before answer.
  • rejected — the destination rejected the call.
  • on_call_event — an in-call event occurred (see event_payload).
Available options:
call_setup,
ringing,
early_media,
answered,
completed,
busy,
cancelled,
rejected,
on_call_event
Example:

"call_setup"

​
event_time
string<date-time>

Date and time of the latest event

Example:

"2025-09-22T12:56:38.547Z"

​
event_payload
object

Event-specific data

Example:
{
  "type": "audio",
  "payload": {
    "status": "completed",
    "playback_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}
​
from
string

Caller ID

Example:

"+18045961058"

​
to
string

Destination number

Example:

"17653889567"

​
call_started
string<date-time>

Date and time when the call started

Example:

"2025-09-22T12:56:38.547Z"

​
call_answered
string<date-time> | null

Date and time when the call was answered

​
call_completed
string<date-time> | null

Date and time when the call ended

​
machine_detected
boolean

Indicates whether the call was answered by an answering machine

Example:

false

​
tag
string

Call metadata

Example:

""