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
}
'

import requests

url = "https://api.wavix.com/v1/calls"

payload = {
    "from": "+1234567890",
    "to": "+1987654321",
    "callback_url": "https://examples.com/callback",
    "recording": False,
    "voicemail_detection": False,
    "tag": "marketing-campaign",
    "timeout": 60
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    from: '+1234567890',
    to: '+1987654321',
    callback_url: 'https://examples.com/callback',
    recording: false,
    voicemail_detection: false,
    tag: 'marketing-campaign',
    timeout: 60
  })
};

fetch('https://api.wavix.com/v1/calls', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.wavix.com/v1/calls",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'from' => '+1234567890',
    'to' => '+1987654321',
    'callback_url' => 'https://examples.com/callback',
    'recording' => false,
    'voicemail_detection' => false,
    'tag' => 'marketing-campaign',
    'timeout' => 60
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.wavix.com/v1/calls"

	payload := strings.NewReader("{\n  \"from\": \"+1234567890\",\n  \"to\": \"+1987654321\",\n  \"callback_url\": \"https://examples.com/callback\",\n  \"recording\": false,\n  \"voicemail_detection\": false,\n  \"tag\": \"marketing-campaign\",\n  \"timeout\": 60\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.wavix.com/v1/calls")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"from\": \"+1234567890\",\n  \"to\": \"+1987654321\",\n  \"callback_url\": \"https://examples.com/callback\",\n  \"recording\": false,\n  \"voicemail_detection\": false,\n  \"tag\": \"marketing-campaign\",\n  \"timeout\": 60\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.wavix.com/v1/calls")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"from\": \"+1234567890\",\n  \"to\": \"+1987654321\",\n  \"callback_url\": \"https://examples.com/callback\",\n  \"recording\": false,\n  \"voicemail_detection\": false,\n  \"tag\": \"marketing-campaign\",\n  \"timeout\": 60\n}"

response = http.request(request)
puts response.read_body

{
  "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": ""
}

{
  "success": false,
  "message": "Validation error",
  "errors": {
    "to": "required"
  }
}

{
  "success": false,
  "error": true,
  "message": "Unauthorized"
}

POST

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
}
'

import requests

url = "https://api.wavix.com/v1/calls"

payload = {
    "from": "+1234567890",
    "to": "+1987654321",
    "callback_url": "https://examples.com/callback",
    "recording": False,
    "voicemail_detection": False,
    "tag": "marketing-campaign",
    "timeout": 60
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    from: '+1234567890',
    to: '+1987654321',
    callback_url: 'https://examples.com/callback',
    recording: false,
    voicemail_detection: false,
    tag: 'marketing-campaign',
    timeout: 60
  })
};

fetch('https://api.wavix.com/v1/calls', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.wavix.com/v1/calls",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'from' => '+1234567890',
    'to' => '+1987654321',
    'callback_url' => 'https://examples.com/callback',
    'recording' => false,
    'voicemail_detection' => false,
    'tag' => 'marketing-campaign',
    'timeout' => 60
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.wavix.com/v1/calls"

	payload := strings.NewReader("{\n  \"from\": \"+1234567890\",\n  \"to\": \"+1987654321\",\n  \"callback_url\": \"https://examples.com/callback\",\n  \"recording\": false,\n  \"voicemail_detection\": false,\n  \"tag\": \"marketing-campaign\",\n  \"timeout\": 60\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.wavix.com/v1/calls")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"from\": \"+1234567890\",\n  \"to\": \"+1987654321\",\n  \"callback_url\": \"https://examples.com/callback\",\n  \"recording\": false,\n  \"voicemail_detection\": false,\n  \"tag\": \"marketing-campaign\",\n  \"timeout\": 60\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.wavix.com/v1/calls")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"from\": \"+1234567890\",\n  \"to\": \"+1987654321\",\n  \"callback_url\": \"https://examples.com/callback\",\n  \"recording\": false,\n  \"voicemail_detection\": false,\n  \"tag\": \"marketing-campaign\",\n  \"timeout\": 60\n}"

response = http.request(request)
puts response.read_body

{
  "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": ""
}

{
  "success": false,
  "message": "Validation error",
  "errors": {
    "to": "required"
  }
}

{
  "success": false,
  "error": true,
  "message": "Unauthorized"
}

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"

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"

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 | null

Event-specific data

Show child attributes

Example:

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

from

string

Caller ID

Example:

"+18045961058"

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:

""

List active calls

Retrieve a call

⌘I

Using the APIs

API reference

WebSocket protocol

Start a call

Authorizations

Body

Response